Конфигурация Web-приложения
Параметры конфигурации web-приложения системы Центральный Пульт хранятся в конфигурационном файле /etc/saymon/saymon-client.yaml.
NOTE
Файлы с параметрами конфигурации web-приложения могут храниться в следующих файлах (в порядке снижения приоритета): MongoDB – параметры конфигурации, которые можно изменить через REST API;
/etc/saymon/saymon-client.yaml– параметры конфигурации web-приложения в формате YAML (основной файл конфигурации);/etc/saymon/saymon-client.json– параметры конфигурации web-приложения в формате JSON (дополнительный файл конфигурации);./backend/server/saymon-client-default.yaml– параметры конфигурации web-приложения по умолчанию. Файл конфигурации с низким приоритетом используется в том случае, если отсутствует файл конфигурации с высоким приоритетом.
Также, параметры конфигурации могут храниться в файле /etc/saymon/client-config.js. Этот способ конфигурации устарел и не должен быть использован с новыми версиями web-приложения.
agentInstallerUrl
Ссылка для скачивания установочного скрипта для агента.
- YAML
- JSON
yaml
agentInstallerUrl: example.com/saymon-agent-installation.shjson
{
"agentInstallerUrl": "example.com/saymon-agent-installation.sh",
...
}Ссылка добавляется в сгенерированную команду для установки агента при автоинсталляции.

По умолчанию ссылка не задана.
authEnabled
Включает самостоятельную регистрацию для пользователей;
- YAML
- JSON
yaml
authEnabled: falsejson
{
"authEnabled": false,
...
}- false – регистрация выключена,
- true – регистрация включена.
По умолчанию – false – регистрация выключена.
authTokenEnabled
Настраивает отображение поля Ссылка для авторизации и кнопки создания токена API в окне настроек пользователя.
- YAML
- JSON
yaml
authTokenEnabled: falsejson
{
"authTokenEnabled": false,
...
}- false – поле выключено,
- true – поле включено.
По умолчанию – true – поле включено.
authentication
В этой секции можно настроить параметры аутентификации пользователей.
- YAML
- JSON
yaml
authentication:
availableMethods:
- native
- keycloak
methodByDefault: keycloak
services:
keycloak:
configUri: keycloak_frontend.json
legacySupport: falsejson
{
"authentication": {
"availableMethods": [
"native",
"keycloak"
],
"methodByDefault": "keycloak",
"services": {
"keycloak": {
"configUri": "keycloak_frontend.json",
"legacySupport": false
}
}
}
}authentication. availableMethods
Список доступных методов аутентификации:
- native – аутентификация по логину и паролю пользователя;
- keycloak – аутентификация через реквизиты учетной записи пользователя в Keycloak.
По умолчанию – native.
authentication. methodByDefault
Метод аутентификации, который используется по умолчанию.
По умолчанию – native.
authentication. services
Секция с настройками сервисов аутентификации.
authentication.services. keycloak
Секция с настройками аутентификации через реквизиты учетной записи в Keycloak.
authentication.services.keycloak. configUri
Имя файла настроек соединения, сгенерированного Keycloak-сервером для web-приложения.
Файл настроек соединения необходимо разместить на сервере системы Центральный Пульт в каталоге /etc/saymon.
authentication.services.keycloak. legacySupport
Включает поддержку работы с Keycloak-сервером версии ниже 19;
- false – поддержка работы с Keycloak-сервером версии ниже 19 выключена;
- true – поддержка работы с Keycloak-сервером версии ниже 19 включена.
По умолчанию – false (работа с Keycloak-сервером версии ниже 19 не поддерживается).
canEditObjectStyle
Включает возможность вручную настраивать CSS-стили для объектов и связей.
- YAML
- JSON
yaml
canEditObjectStyle: truejson
{
"canEditObjectStyle": true,
...
}При включении опции в разделе Параметры появляется подраздел Стили (объектов, связей);
NOTE
При выключении опции, применённые стили не убираются с объектов и связей.
- false – настройка стилей выключена,
- true – настройка стилей включена.
По умолчанию – true – настройка стилей включена.
comet
Секция с настройками взаимодействия web-приложения с сервером системы Центральный Пульт через Comet-сервер.
- YAML
- JSON
yaml
comet:
port: 8091
url:
- "https://cpult.ru/ws"
- "http://10.78.5.11:8092"json
{
"comet": {
"port": 8091,
"url": [
"https://cpult.ru/ws",
"http://10.78.5.11:8092"
]
}
}comet. port
Номер порта, по которому web-приложение подключается к Comet-серверу.
По умолчанию используется порт 8091.
comet. url
Адреса для подключения web-приложения к Comet-серверу из разных сетей. При задании адреса можно использовать IP-адрес, доменное имя или имя хоста. Также дополнительно можно указывать порт.
Если задано несколько адресов, то при установке подключения осуществляется их перебор до успешной установки соединения. Адрес выбирается случайным образом.
NOTE
Если задан параметр comet.url , то параметр comet.port игнорируется.
configuration
Секция с настройками окна конфигурации системы.
- YAML
- JSON
yaml
configuration:
objectPermissions:
displayType: treejson
{
"configuration": {
"objectPermissions": {
"displayType": "tree"
}
}
}configuration. objectPermissions
Настройки доступа к объектам.
configuration.objectPermissions. displayType
Настройки вида отображения списка объектов.
tree– интерфейс управления правами в виде дерева всех объектов в системе,simple– упрощённый интерфейс управления правами доступа к объектам.
По умолчанию – tree.
collapseSections
Задаёт настройки первоначального отображения секций и графиков;
- YAML
- JSON
yaml
collapseSections: truejson
{
"collapseSections": true,
...
}- false – секции закреплены, графики раскрыты,
- true – секции откреплены, графики свёрнуты.
По умолчанию – true – секции откреплены, графики свёрнуты.
defaultClassImage
Позволяет задать стандартное изображение и его размер для объектов определенного класса.
- YAML
- JSON
yaml
defaultClassImage:
"29":
img: /images/cloud.svg
dim:
- 300
- 200json
{
"defaultClassImage": {
"29": {
"img": "/images/cloud.svg",
"dim": [
156,
104
]
}
}
}defaultClassImage. <number>
Идентификатор класса, например, "29".
defaultClassImage.<number>. img
Путь до изображения относительно папки /usr/local/saymon/client/.
NOTE
Стандартным изображением может быть только векторный файл в формате SVG. Изображения других форматов (например PNG, JPEG или GIF) будут отображаться в окне настройки класса , но не будут отображаться в окне параметров и стандартном виде .
defaultClassImage.<number>. dim
Размер изображения (в пикселях, [ширина, высота]).
По умолчанию – [300, 200]
defaultEmbeddableLink
Настройка ссылки под встраиваемым виджетом, которая генерируется по умолчанию. При встраивании, эту ссылку можно изменить.
Этот раздел позволяет настроить текст и URL ссылки под виджетом:

- YAML
- JSON
yaml
defaultEmbeddableLink:
url: http://cpult.ru/
name: Центральный Пультjson
{
"defaultEmbeddableLink": {
"url": "http://cpult.ru/",
"name": "Центральный Пульт"
},
}defaultEmbeddableLink. url
URL ссылки под виджетом.
defaultEmbeddableLink. name
Текст ссылки под виджетом.
defaultPieChartColors
Цвета секторов по умолчанию для круговой и радиальной диаграмм. Если секторов больше чем цветов по умолчанию, цвета начинают повторяться сначала.
- YAML
- JSON
yaml
defaultPieChartColors:
- "#a90329"
- "#3276b1"
- "#009F3D"
- "#9868B8"
- "#F2C001"
- "#FF742C"
- "#90574E"
- "#EB77BE"
- "#FF9796"
- "#AAC6E5"
- "#8BDE90"
- "#FDB5D0"json
{
"defaultPieChartColors": [
"#a90329",
"#3276b1",
"#009F3D",
"#9868B8",
"#F2C001",
"#FF742C",
"#90574E",
"#EB77BE",
"#FF9796",
"#AAC6E5",
"#8BDE90",
"#FDB5D0"
]
}disabledSections
Позволяет удалить секции, которые показываются при подробном отображении объекта в верхней части экрана.
- YAML
- JSON
yaml
disabledSections:
- audit-log
- config-log
...json
{
"disabledSections": [
"audit-log",
"config-log",
...
]
}Список всех доступных секций:
- audit-log (История изменений),
- config-log (Изменения конфигурации),
- documents (Документы),
- entity-incident-conditions (Условия генерации аварий),
- entity-settings (Параметры объектов, связей),
- entity-state-conditions (Условия перехода состояний),
- history-graph (Графики),
- monitoring (Мониторинг),
- operations (Операции),
- properties (Свойства),
- stat (Данные),
- stat-rules (Правила формирования данных),
- state-history (История состояний),
- state-triggers (Действия при смене состояний),
- widgets (Виджеты).
По умолчанию – пустой список, все секции включены.
documentation
В этом разделе можно настроить ссылки на различную документацию системы Центральный Пульт.
- YAML
- JSON
yaml
documentation:
main:
root: https://docs.saymon.tech
ru: https://docs.cpult.ru
notificationTemplates:
root: xref:web-interface:system-configuration-window/notification-templates.html
ru: xref:web-interface:system-configuration-window/notification-templates.html
restApi:
root: https://api.cpult.rujson
"documentation": {
"main": {
"root": "https://docs.saymon.tech",
"ru": "https://docs.cpult.ru"
},
"notificationTemplates": {
"root": "xref:web-interface:system-configuration-window/notification-templates.html",
"ru": "xref:web-interface:system-configuration-window/notification-templates.html"
},
"restApi": {
"root": "https://api.cpult.ru"
}
}NOTE
Ссылки, которые не начинаются с
http://илиhttps://относительны от адреса сервера системы Центральный Пульт. Например, следующая конфигурация откроет документацию по адресуhttp://<saymon-hostname>/documentation/ru:
Для каждого поддерживаемого языка можно задать свою ссылку:
root/en– английский язык;ru– русский язык;it– итальянский язык.
Например, конфигурация ссылок на документацию REST API для каждого поддерживаемого языка может выглядеть следующим образом:
yaml
documentation:
restApi:
en: https://docs.saymon.tech
ru: https://example.com/docs/ru-RU
it: documentation/Italiano # https://<saymon-hostname>/documentation/Italianodocumentation. main
Ссылки на пользовательскую документацию.
По умолчанию:
- https://docs.saymon.tech (английский и итальянский);
- https://docs.cpult.ru (русский).
documentation. restApi
Ссылки на документацию по REST API.
По умолчанию (для всех языков) – https://api.cpult.ru
documentation. notificationTemplates
Ссылка на описание шаблонов уведомлений. Документация открывается по нажатию на кнопку "Подробнее" в настройках шаблонов уведомлений:

По умолчанию – ссылка на статью Шаблоны уведомлений.
enableAnalytics
Включает функционал модуля аналитики;
- YAML
- JSON
yaml
enableAnalytics: falsejson
{
"enableAnalytics": false,
...
}- false – функционал выключен,
- true – функционал включен.
По умолчанию – false – функционал выключен.
enableJiraTrigger
Включает возможность создать задачу в Jira при смене состояния объекта.
- YAML
- JSON
yaml
enableJiraTrigger: falsejson
{
"enableJiraTrigger": false,
...
}- false – функционал выключен,
- true – функционал включен.
По умолчанию – false – функционал выключен.
enableConditionalIncidents
Включает функционал генерации аварий;
- YAML
- JSON
yaml
enableConditionalIncidents: falsejson
{
"enableConditionalIncidents": false,
...
}- false – функционал выключен,
- true – функционал включен.
По умолчанию – false – функционал выключен.
enableSmsTrigger
Включает использование SMS-уведомлений;
- YAML
- JSON
yaml
enableSmsTrigger: falsejson
{
"enableSmsTrigger": false,
...
}- false – SMS-уведомления выключены,
- true – SMS-уведомления включены.
По умолчанию – false – SMS-уведомления выключены.
enableSnmpTranslate
Включает трансляцию SNMP OID в текстовый формат;
- YAML
- JSON
yaml
enableSnmpTranslate: falsejson
{
"enableSnmpTranslate": false,
...
}- false – трансляция выключена,
- true – трансляция включена.
По умолчанию – false – трансляция выключена.
enableVoiceCallTrigger
Включает использование голосовых вызовов;
- YAML
- JSON
yaml
enableVoiceCallTrigger: falsejson
{
"enableVoiceCallTrigger": false,
...
}- false – голосовые вызовы выключены,
- true – голосовые вызовы включены.
По умолчанию – false – голосовые вызовы выключены.
experimental
Включает экспериментальный функционал в различных частях системы.
- YAML
- JSON
yaml
experimental: falsejson
{
"experimental": false,
...
}forceEmptyStandardView
Список классов для которых пользовательский интерфейс будет по умолчанию открывать стандартный вид, даже при отсутствии дочерних объектов.
- YAML
- JSON
yaml
forceEmptyStandardView:
- 1
- 3
- 13
- 43json
{
"forceEmptyStandardView": [
1,
3,
13,
43
]
}При выборе объекта, в том числе не содержащего вложенных объектов, Центральный Пульт по умолчанию показывает для него подробную информацию.
В параметре задаётся список идентификаторов классов, при выборе пустых объектов которых Центральный Пульт переходит в стандартный вид.
По умолчанию:
- 1 (Root),
- 3 (Host),
- 13 (Node),
- 43 (Dashboard).
NOTE
Система запоминает последний выбранный вид отображения для каждого объекта в локальном хранилище браузера. Если этот вид отличается от стандартного, то система выбирает последний выбранный вид.
geoMap
Центральный Пульт позволяет привязывать объекты к их геоположению и просматривать их на карте.
- YAML
- JSON
yaml
geoMap:
serverName: openstreetmap.org
initialPosition:
- 30.341306
- 59.930089
initialZoom: 8json
{
"geoMap": {
"serverName": "openstreetmap.org",
"initialPosition": [
30.341306,
59.930089
],
"initialZoom": 8
}
}geoMap. initialPosition
Начальная позиция на карте в формате [долгота, широта].
Позиция указывается как массив из двух значений, где первое значение это широта, а второе – долгота:
- YAML
- JSON
yaml
initialPosition:
- 30.341306
- 59.930089json
"initialPosition": [
30.341306,
59.930089
],По умолчанию – [30.341306,59.930089].
NOTE
Если указать данные, выходящие за пределы допустимых значений ([0,90] для широты, [0,180] для долготы), то произойдёт ошибка и карта не будет отображаться.
geoMap. initialZoom
Начальный масштаб карты. Допустимые значения - от 2 до 20. При выходе за эти границы, значение ограничивается допустимыми значениями.
По умолчанию – 8.
geoMap. serverName
Имя сервера OpenStreetMap, отвечающего за отображения карты. Имя должно быть указано без протокола, например openstreetmap.org или 192.168.1.10/maps.
По умолчанию – openstreetmap.org
Также можно использовать локальный OSM-сервер.
geoMap. skipModalView
При нажатии на объект в режиме Геокарты пропустить модальное окно и сразу открывать информацию в виде по умолчанию для этого объекта.
grid
В разделе задаются настройки сетки для выравнивания объектов в стандартном виде.

- YAML
- JSON
yaml
grid:
dim: 20
color: rgba(128, 128, 128, 0.3)
border: 4json
{
"grid": {
"dim": 20,
"color": "rgba(128, 128, 128, 0.3)",
"border": 4
}
}grid. dim
Размер сетки (в пикселях).
NOTE
Если указано некорректное значение (например, 0 или отрицательное число), то сетка не будет отображаться, но положение объектов будет привязываться к стандартному размеру сетки (20 пикселей).
По умолчанию – 20.
grid. color
Цвет сетки в формате RGBA.
По умолчанию – rgba(128, 128, 128, 0.3).
grid. border
Максимальное значение отступа границы объекта от границы сетки (в пикселях).
Поведение объекта при изменении его размера со стандартными настройками (border: 20, dim: 4):

По умолчанию – 4.
gridView
В разделе задаются параметры отображения объектов в виде сетки.
- YAML
- JSON
yaml
gridView:
cols: 6
colWidth: 240
rowHeight: 90
gutterSize: 5json
{
"gridView": {
"cols": 6,
"colWidth": 240,
"rowHeight": 90,
"gutterSize": 5
}
}gridView. cols
Количество объектов в строке сетки.
При gridView.cols > 0 ширина объектов меняется автоматически.
При gridView.cols = 0 число объектов в строке сетки подстраивается под ширину экрана.
По умолчанию – 6.
gridView. colWidth
Ширина объектов при gridView.cols = 0 (в пикселях).
По умолчанию – 240.
gridView. rowHeight
Высота объектов (в пикселях).
По умолчанию – 90.
gridView. gutterSize
Величина отступа между объектами (в пикселях).
По умолчанию – 5.
history
В этом разделе задаются параметры, отвечающие за отображение данных на графиках, а также активируются некоторые дополнительные элементы интерфейса.
- YAML
- JSON
yaml
history:
downsampling:
- period: 1-hours
dsp: 60s-avg
- period: 1-days
dsp: 5m-avg
- period: 1-weeks
dsp: 1h-avg
- dsp: 1d-avg
modelChangeAnnotations: false
pagination: false
paginationLimit: 10json
{
"history": {
"downsampling": [
{
"period": "1-hours",
"dsp": "60s-avg"
},
{
"period": "1-days",
"dsp": "5m-avg"
},
{
"period": "1-weeks",
"dsp": "1h-avg"
},
{
"dsp": "1d-avg"
}
],
"modelChangeAnnotations": false,
"pagination": false,
"paginationLimit": 10
}
}history. downsampling
Параметры уменьшения размера выборки данных – downsampling.
NOTE
Если в файл конфигурации добавлен раздел downsampling , то значения по умолчанию не используются. Если сервер не найдёт подходящие настройки даунсэмплинга, то вместо графика будет показана ошибка "Нет данных для выбранного диапазона".
history.downsampling. period
Период выборки данных.
Настройка периода имеет следующий формат:
text
<количество>-<hours|days|weeks|months>history.downsampling. dsp
Настройка способа даунсэмплинга данных.
Настройка имеет следующий формат:
text
<количество><префикс-промежутка-времени>-<avg|min|max>Доступные префиксы промежутков времени:
s– секунды;m– минуты;h– часы;d– дни.
На примере ниже представлены примеры конфигурации способа даунсэмплинга данных.
- "dsp: 5m-avg"
- "dsp: 15s-avg"
При следующей конфигурации, при выбранном врменном диапазоне в 6 часов, на графике будут отображены средние значения за каждые 5 минут.
yaml
history:
downsampling:
- period: 6-hours
dsp: 5m-avg
При следующей конфигурации, при выбранном временном диапазоне в 6 часов, на графике будут отображены средние значения за каждые 15 секунд.
yaml
history:
downsampling:
- period: 6-hours
dsp: 15s-avg
NOTE
Если не указан параметр period , то такой параметр dsp становится параметром по умолчанию для всех периодов, которые не указаны в файле конфигурации.
history. modelChangeAnnotations
Включает смену аннотаций на графиках.
- false – смена аннотаций выключена,
- true – смена аннотаций включена.
По умолчанию – false – смена аннотаций выключена.
history. pagination
Включение постраничного вывода на графиках.
- false – постраничный вывод на графиках выключен,
- true – постраничный вывод на графиках включена.
По умолчанию – false – постраничный вывод на графиках выключен.
history. paginationLimit
Количество графиков на одной странице.
По умолчанию – 10.
hideConnectionStatusNotifications
Скрывает оповещения о статусе соединения с Comet-сервером;
- YAML
- JSON
yaml
hideConnectionStatusNotifications: falsejson
{
"hideConnectionStatusNotifications": false,
...
}- false – оповещения выводятся в web-интерфейс,
- true – оповещения выводятся в консоль.
По умолчанию – false – оповещения о статусе соединения с Comet-сервером выводятся в web-интерфейс.
hideResponseErrorNotifications
Скрывает оповещения об ошибках, возникающих при отправке автоматических запросов на сервер.
- YAML
- JSON
yaml
hideResponseErrorNotifications: falsejson
{
"hideResponseErrorNotifications": false,
...
}- false – оповещения выводятся в web-интерфейс,
- true – оповещения скрыты.
По умолчанию – false – оповещения выводятся в web-интерфейс.
NOTE
Ошибки, возникающие при действиях пользователя, например сохранение каких-либо данных в формах, будут выводиться в web-интерфейс в любом случае.
hiddenPropertyTypes
Список типов свойств, скрываемых из интерфейса.
NOTE
Свойства скрываются только из web-интерфейса системы. Скрытые свойства можно возвращать и обновлять соответствующими запросами REST API.
- YAML
- JSON
yaml
hiddenPropertyTypes:
- 101
- 126
- 310
- 514json
{
"hiddenPropertyTypes": [
101,
126,
310,
514
]
}incidents
В этом разделе настраиваются дополнительные поля для списков активных аварий и исторических аварий.
- YAML
- JSON
yaml
incidents:
additionalFields:
- owner.properties.address
- owner.class_id
- updated
additionalFieldNames:
- IP-address
- Object Class IDjson
{
"incidents": {
"additionalFields": [
"owner.properties.address",
"owner.class_id",
"updated"
],
"additionalFieldNames": [
"IP-address",
"Object Class ID"
]
}
}incidents. additionalFields
Источники данных для дополнительных полей.
Источником дополнительного поля может быть любой параметр аварии. Поля параметров-объектов нужно указывать через точку. Например, чтобы указать Свойство address объекта, на котором произошла авария в список additionalFields нужно добавить значение owner.properties.address.
Список всех параметров можно посмотреть в документации REST API.
NOTE
Только свойства с type_id = 1 (свойства, добавленные через окно Свойство или через REST API) можно использовать как источники данных. Нельзя добавлять встроенные параметры и параметры сенсора, например TaskType или PingHost , а также ссылки, добавленные как Документы .
NOTE
Если источнику данных не соответствует имя поля в списке additionalFieldNames , то в заголовке столбца будет указано название источника данных.
incidents. additionalFieldNames
Имена дополнительных полей, отображаемые в интерфейсе.
Список имён соотносится со списком источников данных. То есть, первому источнику в списке additionalFields соответствует первое имя в списке additionalFieldNames, второму – второе и так далее.
Количество имён может не совпадать с количеством источников данных. Если источнику данных не соответствует имя поля, то в заголовке столбца будет указано название источника данных.
Чтобы пропустить источник данных и использовать название источника данных, нужно записать null или false.
Например, следующая конфигурация добавит в списки аварий столбцы localTimestamp, 'Owner ID', IP Address и owner.class_id:
yaml
incidents:
additionalFields:
- localTimestamp
- owner._id
- owner.properties.address
- timestamp
- owner.class_id
additionalFieldNames:
- false
- IP-address
- Object Class IDlanguages
Раздел позволяет управлять предустановленными языками интерфейса web-приложения.
По умолчанию, в системе доступен только русский язык. Для включения других языков, их все нужно в явном виде указать в файле конфигурации.
- YAML
- JSON
yaml
languages:
en:
short: us
long: English
ru:
short: ru
long: Русский
it:
short: it
long: Italianojson
{
"languages": {
"en": {
"short": "us",
"long": "English"
},
"ru": {
"short": "ru",
"long": "Русский"
},
"it": {
"short": "it",
"long": "Italiano"
}
}
}languages. <id>
Идентификатор языка.
Доступны три языка:
- en – английский,
- it – итальянский,
- ru – русский.
NOTE
Если указать другой язык, то он добавится в список языков в меню текущего пользователя , но будет использовать английскую локализацию.
languages.<id>. long
Полное название языка.
Это название отображается в меню текущего пользователя интерфейса системы Центральный Пульт при выборе языка интерфейса.
languages.<id>. short
Идентификатор иконки флага.
Иконка отображается в меню текущего пользователя интерфейса системы Центральный Пульт при выборе языка интерфейса.
– es,
– gb,
– it,
– ru,
– us.
NOTE
Если указать несуществующий или некорректный идентификатор, то будет использован флаг .
monitoring
В этом разделе задаются настройки сенсоров мониторинга, такие как скрытие стандартных мониторинговых сенсоров из интерфейса и привязка словарей для мониторинга к сенсорам.
- YAML
- JSON
yaml
monitoring:
standardTasks:
- ping
- snmpGet
taskDictionaries:
ftp: # Стандартная задача для мониторинга FTP соединения
- dictionary: connection-credentials # Словарь учётных данных подключений
mapping:
user: FtpLogin # Связь поля user из словаря с параметром FtpLogin задачи
password: FtpPassword
jmx:
- dictionary: connection-credentials
mapping:
user: JmxLogin
password: JmxPassword
snmpGet:
- dictionary: snmp-credentials
mapping:
communityRead: SnmpCommunity
user: SnmpUser
authType: SnmpAuth
authPassword: SnmpAuthPass
privType: SnmpPriv
privPassword: SnmpPrivPassjson
{
"monitoring": {
"standardTasks": [
"ping",
"snmpGet"
],
"taskDictionaries": {
"ftp": [
{
"dictionary": "connection-credentials",
"mapping": {
"user": "FtpLogin",
"password": "FtpPassword"
}
}
],
"jmx": [
{
"dictionary": "connection-credentials",
"mapping": {
"user": "JmxLogin",
"password": "JmxPassword"
}
}
],
"snmpGet": [
{
"dictionary": "snmp-credentials",
"mapping": {
"communityRead": "SnmpCommunity",
"user": "SnmpUser",
"authType": "SnmpAuth",
"authPassword": "SnmpAuthPass",
"privType": "SnmpPriv",
"privPassword": "SnmpPrivPass"
}
}
]
}
}
}monitoring. standardTasks
Список идентификаторов отображаемых стандартных сенсоров. Список идентификаторов можно посмотреть в разделе Список идентификаторов стандартных сенсоров.
Если этот раздел не задан в файле конфигурации, то в интерфейсе отображаются все стандартные сенсоры.
monitoring. taskDictionaries
Привязка словарей для мониторинга к сенсорам мониторинга (в том числе и пользовательских).
Сенсоры задаются следующим образом:
- YAML
- JSON
yaml
monitoring:
taskDictionaries:
ftp:
- dictionary: connection-credentials
...
jmx:
- dictionary: connection-credentials
...
snmpGet:
- dictionary: snmp-credentials
...
custom/probe.sh:
- dictionary: custom-probe-dictionary
...
- dictionary: 672c7063066d7b194b37563c
...json
{
"monitoring": {
"taskDictionaries": {
"ftp": [
{
"dictionary": "connection-credentials",
...
}
],
"jmx": [
{
"dictionary": "connection-credentials",
...
}
],
"snmpGet": [
{
"dictionary": "snmp-credentials",
...
}
],
"custom/probe.sh": [
{
"dictionary": "custom-probe-dictionary",
...
"dictionary": "672c7063066d7b194b37563c",
...
}
]
}
}
}monitoring.taskDictionaries. dictionary
Идентификатор связываемого с сенсором словаря. Это единственный обязательный параметр. Если этот параметр не указан, система проигнорирует эту запись.
К каждому сенсору может быть привязано больше одного словаря.
monitoring.taskDictionaries. name
Альтернативное наименование словаря, которое будет отображено для него в пользовательском интерфейсе выбора словаря для сенсора. Может быть использовано, если собственное наименование словаря не подходит, а также для локализации на поддерживаемые системой языки.
- YAML
- JSON
yaml
name:
- en: My dictionary
- ru: Мой словарь
- ..: ...json
{
"name": [
{
"en": "My dictionary"
},
{
"ru": "Мой словарь"
},
{
"..": "..."
}
]
}NOTE
При отсутствии необходимого значения для текущего выбранного языка, будет использовано первое значение найденное в этом списке.
monitoring.taskDictionaries. map_all
Автоматическое назначение всех полей словаря в соответствующие (по наименованию) свойства сенсора.
true– система автоматически назначает соответствующие поля словаря,false– система использует поля, определённые в полеmonitoring.taskDictionaries.mapping.
По умолчанию – false – система использует поля, определённые в поле monitoring.taskDictionaries.mapping.
monitoring.taskDictionaries. mapping
Определяет карту связи полей из словаря с параметрами сенсора. Если данный параметр не указан, то производится связь всех именованных полей словаря с идентичными по названию параметрами сенсора.
Используется, если имена параметров сенсора отличаются от наименований полей в словаре.
monitoring.taskDictionaries. exclude
Список полей словаря, которые не будут связаны с параметрами сенсора.
Данный параметр необходим только в тех случаях, когда надо исключить пересечение наименований при использовании нескольких словарей в одном сенсоре и одновременно включённом параметре map_all.
monitoring.taskDictionaries. template_for
Имя свойства сенсора, формирование которого будет определять текстовый шаблон выбранный из данного словаря.
millisecondMonitoring
Включает обновление данных каждую миллисекунду.
- YAML
- JSON
yaml
millisecondMonitoring: falsejson
{
"millisecondMonitoring": false,
...
}- false – обновление выключено,
- true – обновление включено.
По умолчанию – false – обновление выключено.
pollInterval
Интервал между запросами данных с REST-сервера, если соединение между клиентом и Comet-сервером недоступно (в миллисекундах).
- YAML
- JSON
yaml
pollInterval: 5000json
{
"pollInterval": 5000,
...
}По умолчанию – 5000 – 5 секунд.
pollIntervalSocket
Интервал между запросами данных с Comet-сервера, если соединение между клиентом и Comet-сервером доступно (в миллисекундах).
- YAML
- JSON
yaml
pollIntervalSocket: 60000json
{
"pollIntervalSocket": 60000,
...
}По умолчанию – 60000 – 1 минута.
statHistory
Отображать кнопку "Показать историю данных".
- YAML
- JSON
yaml
statHistory: falsejson
{
"statHistory": false,
...
}- true – кнопка включена,
- false – кнопка выключена.
NOTE
Параметр серверной конфигурации agent_stat должен быть включён.
По умолчанию – false
title
Заголовок для вкладок, а также имя, отображаемое в левом верхнем углу web-интерфейса.
- YAML
- JSON
yaml
title: "SAYMON"json
{
"title": "SAYMON",
...
}По умолчанию – SAYMON.
themes
Этот параметр отвечает за настройку тем.
- YAML
- JSON
yaml
themes:
default:
name: Light
dark:
name: Darkjson
{
"themes": {
"default": {
"name": "Light"
},
"dark": {
"name": "Dark"
}
}
}CSS-файлы с темами находятся в директории /usr/local/saymon/client/css.
По умолчанию доступно две темы – светлая (default) и тёмная (dark).
Чтобы добавить новую тему, нужно создать в директории с темами новую папку (например, my-custom-theme). Затем, добавить эту папку в файл конфигурации:
- YAML
- JSON
yaml
themes:
my-custom-theme:
name: Custom Themejson
{
"themes": {
"my-custom-theme": {
"name": "Custom Theme"
}
}
}themes.<theme-name>. name
Название темы в меню текущего пользователя.
NOTE
Название темы нельзя локализовать на разные языки.
tree
В этом разделе задаются настройки для дерева объектов.
- YAML
- JSON
yaml
tree:
filterSubmit: truejson
{
"tree": {
"filterSubmit": true
},
}tree. filterSubmit
Включает кнопку применения фильтра и отключает его автоматическое применение при вводе символов.
Кнопка применения фильтра отображается рядом с кнопкой сброса фильтра при вводе нового фильтра:

- false – кнопка выключена,
- true – кнопка включена.
По умолчанию – false – кнопка выключена.
useNaturalSort
Включает сортировку объектов с помощью библиотеки javascript-natural-sort:
- YAML
- JSON
yaml
useNaturalSort: falsejson
{
"useNaturalSort": false,
...
}- false – объекты сортируются с помощью нативных функций браузера,
- true – объекты сортируются с помощью библиотеки javascript-natural-sort.
По умолчанию – false – объекты сортируются с помощью нативных функций браузера.
NOTE
При установленном useNaturalSort = true возможно замедление работы web-интерфейса при большом количестве объектов в системе (от 100 000).