Page tree

SAYMON документация

Skip to end of metadata
Go to start of metadata

Конфигурация сервера системы выполняется в файле

  /etc/saymon/saymon-server.conf

Далее приведены описания разделов и настроек.

В разделе  cache задается пароль для доступа к серверу Redis:

"auth_pass" : "пароль"

В разделе  mqtt задаются настройки подключения к MQTT-брокеру:

"broker" : "адрес и порт брокера", например "mqtt://localhost:1883"

Для аутентификации по связке имя + пароль нужно указать пользовательские данные перед адресом сервера:

"broker" : "mqtt://user:password@localhost:1883"


При использовании SSL-шифрования необходимо добавить пути: к сертификату удостоверяющего центра, к ключу и сертификату клиента:

"ca": "path/to/ca.server.crt",
"certificate": "path/to/client.crt",
"key": "path/to/client.key"


В разделе  openTsdb задаются параметры доступа к OpenTSDB:

"enabled" : "запись исторических данных в OpenTSDB (false или true, по умолчанию true)"
"host" : "адрес хоста с OpenTSDB"
"port" : "порт OpenTSDB"

В разделе  server задаются общие параметры сервера:

"sql_history_enabled" : "запись исторических данных в MySQL (false или true, по умолчанию false)"
"history_update_period" : "интервал записи исторических данных в миллисекундах; 0 - немедленная запись пришедших значений"
"redis_populate_period" : "интервал записи данных об объектах и связях (ID) из MongoDB в Redis (в миллисекундах)"
"default_result_timeout" : "время, через которое срабатывает условие "нет данных" с момента создания объекта или получения последних данных (в миллисекундах)"
"default_state_id" : "состояние объекта при создании (по умолчанию 7 - "нет данных")
"debug" : "debug-режим для логирования в saymon-server.log (false или true, по умолчанию false)"
"sms_script": "путь до скрипта, отправляющего sms-уведомления"
"voice_call_script": "путь до скрипта, осуществляющего голосовой вызов"
"comet_port" : "порт для защищенного соединения"
"comet_secure" : "ssl-соединение (false или true, по умолчанию false)"
"comet_ssl_certificate" : "путь к сертификату"
"comet_ssl_key" : "путь к ключу"
"self_object_id" : "ID объекта, используемого для самомониторинга"
"colorize_log" : "цветная раскраска лога (false или true, по умолчанию false)"
"event_log_max_bytes" : "размер записей консоли в mongoDB в байтах, при достижении которого происходит ротация данных (по умолчанию 1 GB)"
"notification_buffering_period" : "период ожидания для сбора сообщений о смене состояний объектов и отправки пользователю сгруппированного уведомления (в миллисекундах; 0 - отключение буферизации)"
"conditional_incidents_enabled" : "включает функционал инцидентов (false или true, по умолчанию false)"
"discovery_parent_id" : "id объекта, в котором появляются найденные агентами сетевые устройства"
"retain_expired_stat" : "хранение последних полученных данных после их устаревания (false или true, по умолчанию false)"
"stat_local_timestamp_field_name" : "имя поля, в котором передается время, с которым нужно сохранять данные в OpenTSDB (по умолчанию "localTimestamp")"
"server.analytics_enabled" : "включает аналитику значений метрик в процесс обработки данных (false или true, по умолчанию false)"
"server.analytics_processes" : "количество логических ядер, выделяемых для обработки аналитики временных рядов"

В подразделе  email задаются параметры доступа к почтовому серверу:

"disables" : "отправка почтовых уведомлений (false или true, по умолчанию true)"
	"transport" {}
		"host" : "адрес почтового сервера, например, smtp.gmail.com",
        "port" : "порт, например, 465",
        "secure" : "true или false",
		"auth" {}
			"user" : "логин пользователя для доступа к почтовому серверу"
			"pass" : "пароль пользователя для доступа к почтовому серверу"
		"fields" {}
			"from" : "почтовый адрес отправителя, например, saymon@saas.saymon.info"
	"max_json_length": "ограничение размера письма с уведомлением в символах (если не указано - 1000 по умолчанию)"

В разделе  rest_server задаются параметры REST-сервера:

"ip_address" : "адрес хоста для запуска REST-сервера"
"port" : "порт REST-сервера"
"base_url" : "путь к API (по умолчанию `/api`)"
"debug" :  "режим debug для логирования в saymon-rest-server.log (false или true, по умолчанию false)"
"document_storage_dir" : "директория для хранения .pdf, .jpeg и других файлов документации, прикрепляемых к объектам"
"document_download_url" : "url к сохраненным в $document_storage_dir файлам (по умолчанию `http://localhost/node/api/docs`)"
"update_download_url" : "путь к файлу для обновления агента (по умолчанию `http://localhost/node/api/agents/update`)"
"colorize_log" : "цветная раскраска лога (false или true, по умолчанию false)"
"public_url" : "адрес для доступа к WEB-интерфейсу из уведомлений (в формате "https://your.server.com/index.html")"

В разделе  ldap задаются параметры внешнего LDAP-сервера для авторизации пользователей:

"url" : например, "ldap://127.0.0.1:389",
"suffix" : например, "dc=saymon,dc=info",
"login" : например, "cn=admin,dc=saymon,dc=info",
"pass" : например, "root"

В разделе  push_notification задаются параметры push-уведомлений в мобильном приложении:

"disabled" : "отключает уведомления (true или false, по умолчанию false)"
"url" : "url, полученный пользователем от Firebase, для отправки на него содержимого уведомлений с сервера (по умолчанию `https://saymon-mobile.firebaseio.com`)"
"key_path" : "путь к ключу авторизации сервера SAYMON на сервере Firebase (по умолчанию `/etc/saymon/saymon-mobile-firebase-adminsdk.json`)"
"on_state_change" : "отправляет уведомления при изменении состояний, на случай другого источника уведомлений - MQTT-сообщений, (true или false, по умолчанию true)"
"timeout" : "время в миллисекундах, через которое каждому пользователю отправляется уведомление (не чаще чем раз в 5000)"

Для применения изменений необходимо перезапустить сервис saymon-server:

sudo service saymon-server restart
  • No labels