Конфигурационный файл агента

NOTE

Для применения изменений необходимо перезапустить службу saymon-agent (Linux/Mac OS); SaymonAgent (Windows).

Далее описаны параметры конфигурационного файл агента <Папка_установки_агента>/conf/agent.properties.

Параметр	Описание
agent.discoveryEnabled
Включает автоматический поиск агентом сетевых устройств.

false – автоматический поиск выключен,

true – автоматический поиск включен.

По умолчанию – false – автоматический поиск выключен.

Задать родительский объект для обнаруженных устройств можно с помощью параметра discovery_parent_id в разделе Server конфигурационного файла сервера.

| | Задать родительский объект для обнаруженных устройств можно с помощью параметра discovery_parent_id в разделе Server конфигурационного файла сервера. | | | Задать родительский объект для обнаруженных устройств можно с помощью параметра discovery_parent_id в разделе Server конфигурационного файла сервера. | | | | agent.id | Уникальный идентификатор объекта класса Saymon Agent в web-интерфейсе системы.

При указании agent.id=0 на сервере будет создан новый объект класса Saymon Agent. По умолчанию агенты создаются в корневом объекте, задать родительский объект для создаваемых агентов можно с помощью параметра agent_registration_parent_id в разделе Server конфигурационного файла сервера.

ID созданного объекта будет передан агенту. На хосте с агентом будет создан файл …​/saymon-agent/storage/registration.json, где будет записан данный идентификатор.

Чтобы заново инициировать процедуру получения ID, к примеру, если необходимо подключить агента к другому серверу, достаточно удалить файл registration.json и перезапустить агента.

| |

При указании agent.id=0 на сервере будет создан новый объект класса Saymon Agent. По умолчанию агенты создаются в корневом объекте, задать родительский объект для создаваемых агентов можно с помощью параметра agent_registration_parent_id в разделе Server конфигурационного файла сервера.

ID созданного объекта будет передан агенту. На хосте с агентом будет создан файл …​/saymon-agent/storage/registration.json, где будет записан данный идентификатор.

Чтобы заново инициировать процедуру получения ID, к примеру, если необходимо подключить агента к другому серверу, достаточно удалить файл registration.json и перезапустить агента.

| | |

При указании agent.id=0 на сервере будет создан новый объект класса Saymon Agent. По умолчанию агенты создаются в корневом объекте, задать родительский объект для создаваемых агентов можно с помощью параметра agent_registration_parent_id в разделе Server конфигурационного файла сервера.

ID созданного объекта будет передан агенту. На хосте с агентом будет создан файл …​/saymon-agent/storage/registration.json, где будет записан данный идентификатор.

Чтобы заново инициировать процедуру получения ID, к примеру, если необходимо подключить агента к другому серверу, достаточно удалить файл registration.json и перезапустить агента.

| | | | agent.scriptsEnabled | Включает выполнение агентом скриптов с указанным текстом;

false – выполнение скриптов выключено,

true – выполнение скриптов включено.

По умолчанию – true – выполнение скриптов включено. | | | | agent.snmpTrapEnabled | Позволяет использовать агента в качестве получателя трапов.

false – получение трапов агентом выключено,

true – получение трапов агентом включено.

По умолчанию – false – получение трапов агентом выключено.

О возможностях работы с SNMP-Trap читайте в статьях SNMP Trap и Журнал Событий.

| | О возможностях работы с SNMP-Trap читайте в статьях SNMP Trap и Журнал Событий. | | | О возможностях работы с SNMP-Trap читайте в статьях SNMP Trap и Журнал Событий. | | | | agent.snmpTrapListenPort | Порт для получения трапов. По умолчанию – 1162. | | | | agent.snmpTrapReceiverThreadPoolSize | Количество одновременных потоков для получения трапов. По умолчанию – 4. | | | | agent.snmpTrapV3User | Имя клиента для получателя SNMPv3 трапов. Не имеет значения по умолчанию. | | | | agent.snmpTrapV3AuthPassword | Ключ аутентификации получателя SNMPv3 трапов. Не имеет значения по умолчанию. | | | | agent.snmpTrapV3PrivacyPassword | Ключ шифрования для получателя SNMPv3 трапов. Не имеет значения по умолчанию. | | | | metrics.buffer.in-memory.capacity | Включает буфер для сохранения данных от агента при отсутствии связи между агентом и сервером.

Значение параметра – количество наборов данных от агента (результатов проверок), которые будут храниться в буфере до восстановления связи с сервером. После восстановления связи все данные из буфера пересылаются на сервер, и буфер очищается. При переполнении буфера очередные наборы данных заменяют наиболее старые из имеющихся в буфере.

По умолчанию буфер выключен.

Функционал поддерживается агентами версии 5.0.0 и выше.

| | Функционал поддерживается агентами версии 5.0.0 и выше. | | | Функционал поддерживается агентами версии 5.0.0 и выше. | | | | server.host | Адрес сервера Kafka. По умолчанию – 127.0.0.1. | | | | server.port | Порт Kafka, по которому осуществляется подключение агентов к серверу. По умолчанию – 9092. | | | | server.secure | Подключаться к брокеру Kafka через TLS.

Для использования зашифрованного подключения, брокер Kafka должен быть настроен на приём зашифрованных соединений на порте, указанном в параметре server.port (по умолчанию – 9092).

При выключении параметра server.secure, подключение происходит в текстовом формате.

По умолчанию – true.

Так как начиная с агента версии 5.0.0 шифрование включено по умолчанию, при обновлении агента необходимо настроить Kafka для работы через TLS или установить этот параметр в false в файле конфигурации.

| | Так как начиная с агента версии 5.0.0 шифрование включено по умолчанию, при обновлении агента необходимо настроить Kafka для работы через TLS или установить этот параметр в false в файле конфигурации. | | | Так как начиная с агента версии 5.0.0 шифрование включено по умолчанию, при обновлении агента необходимо настроить Kafka для работы через TLS или установить этот параметр в false в файле конфигурации. | | |

Подключение к Kafka Cluster

При использовании Kafka Cluster необходимо также использовать дополнительные параметры подключения, начинающиеся на kafka.; все возможные параметры представлены в документации по Kafka.

Пример:

...
kafka.bootstrap.servers=192.168.1.11:9092,192.168.1.12:9092,192.168.1.13:9092
kafka.security.protocol=SASL_SSL
kafka.ssl.truststore.location=/opt/kafka/kafka.client.truststore.jks
kafka.ssl.truststore.password=saymon
kafka.sasl.mechanism=PLAIN
kafka.sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username="user" password="password"
...

Параметр	Описание
kafka.bootstrap.servers	Список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka.
TIP: Если явно указаны параметры server.host и server.port, то это свойство автоматически генерируется.

NOTE

При использовании Kafka Cluster поле server.host не должно быть пустым, там необходимо указать адрес одного из kafka.bootstrap.servers .

Авторизация и шифрование

Параметр	Описание
kafka.sasl.jaas.config	Параметры контекста входа в систему для SASL-соединений в формате, используемом конфигурационными файлами JAAS.
kafka.sasl.mechanism	Механизм SASL, используемый для клиентских подключений.
kafka.security.protocol
Протокол, используемый для взаимодействия с брокерами.

Возможные значения:

PLAINTEXT,

SSL,

SASL_PLAINTEXT,

SASL_SSL.

Этот параметр связан с параметром server.secure. Если параметр server.secure имеет значение false, то этот параметр может иметь значение PLAINTEXT. Если параметр server.secure выставлен в true или не задан, то он этот параметр может принимать любое значение кроме PLAINTEXT.

| | Этот параметр связан с параметром server.secure. Если параметр server.secure имеет значение false, то этот параметр может иметь значение PLAINTEXT. Если параметр server.secure выставлен в true или не задан, то он этот параметр может принимать любое значение кроме PLAINTEXT. | | | Этот параметр связан с параметром server.secure. Если параметр server.secure имеет значение false, то этот параметр может иметь значение PLAINTEXT. Если параметр server.secure выставлен в true или не задан, то он этот параметр может принимать любое значение кроме PLAINTEXT. | | | | kafka.ssl.truststore.location | Расположение файла truststore. | | | | kafka.ssl.truststore.password | Пароль для файла truststore. Если пароль не задан, сконфигурированный файл также будет использоваться, но без проверки целостности. | | |