Documentation
4 Zabbix агент 2 (UNIX)
Overview
Zabbix agent 2 is a new generation of Zabbix agent and may be used in place of Zabbix agent.
This section lists parameters supported in a Zabbix agent 2 configuration file (zabbix_agent2.conf). Note that:
- The default values reflect process defaults, not the values in the shipped configuration files;
- Zabbix supports configuration files only in UTF-8 encoding without BOM;
- Comments starting with "#" are only supported in the beginning of the line.
Подробности параметра
Alias
Устанавливает псевдоним для ключа элемента. Его можно использовать для замены длинного и сложного ключа элемента более коротким и простым.
Может присутствовать несколько параметров Alias. Несколько параметров с одним и тем же ключом Псевдоним не допускаются.
Разные ключи Псевдонимы могут ссылаться на один и тот же ключ элемента.
Псевдонимы можно использовать в HostMetadataItem, но не в параметре HostnameItem.
Пример 1: Получение идентификатора пользователя «zabbix».
Теперь сокращенный ключ zabbix.userid можно использовать для получения данных.
Пример 2. Получение загрузки ЦП с параметрами по умолчанию и пользовательскими параметрами.
Это позволяет использовать ключ cpu.util для получения процента использования ЦП с параметрами по умолчанию, а также использовать cpu.util[all, Idle, avg15] для получения конкретных данных об использовании ЦП.
Пример 3. Запуск нескольких правил низкоуровневого обнаружения, обрабатывающих одни и те же элементы обнаружения.
Теперь можно настроить несколько правил обнаружения, используя vfs.fs.discovery с разными параметрами для каждого правила, например, vfs.fs.discovery[foo], vfs.fs.discovery[bar] и т. д.
AllowKey
Разрешить выполнение тех ключей элементов, которые соответствуют шаблону. Шаблон ключа – это подстановочное выражение, которое поддерживает символ "*" для соответствия любому количеству любых символов.
В сочетании с DenyKey можно определить несколько правил сопоставления ключей. Параметры обрабатываются один за другим в порядке их появления. См. также: Ограничение проверок агента.
BufferSend
Временной интервал в секундах, который определяет, как часто значения отправляются из буфера на сервер Zabbix. Обратите внимание, что если буфер заполнен, данные будут отправлены раньше.
По умолчанию: 5
Диапазон: 1-3600
BufferSize
Максимальное количество значений в буфере памяти. Агент отправит все собранные данные на сервер Zabbix или прокси-сервер, если буфер заполнен. Этот параметр следует использовать только в том случае, если постоянный буфер отключен (EnablePersistentBuffer=0).
По умолчанию: 100
Диапазон: 2-65535
ControlSocket
Управляющий сокет, используемый для отправки команд времени выполнения с опцией '-R'.
По умолчанию: /tmp/agent.sock
DebugLevel
Укажите уровень отладки:
0 - основная информация о запуске и остановке процессов Zabbix
1 - критическая информация;
2 - информация об ошибках;
3 - предупреждения;
4 — для отладки (выдает много информации);
5 — расширенная отладка (выдает еще больше информации).
По умолчанию: 3
Диапазон: 0-5
DenyKey
Запретить выполнение тех ключей элементов, которые соответствуют шаблону. Шаблон ключа – это подстановочное выражение, которое поддерживает символ "*", соответствующий любому количеству любых символов.
В сочетании с AllowKey можно определить несколько правил сопоставления ключей. Параметры обрабатываются один за другим в порядке их появления. См. также: Ограничение проверок агента.
EnablePersistentBuffer
Включите использование локального постоянного хранилища для активных элементов. Если постоянное хранилище отключено, будет использоваться буфер памяти.
По умолчанию: 0
Значения: 0 – отключено, 1 – включено
ForceActiveChecksOnStart
Выполните активные проверки сразу после перезагрузки для первой полученной конфигурации. Также доступен как параметр конфигурации для каждого плагина, например: Plugins.Uptime.System.ForceActiveChecksOnStart=1
По умолчанию: 0
Значения: 0 – отключено, 1 – включено
Частота сердцебиения
Частота сообщений о пульсе в секундах. Используется для контроля наличия активных проверок.
0 — контрольные сообщения отключены.
По умолчанию: 60
Диапазон: 0-3600
HostInterface
Необязательный параметр, определяющий интерфейс хоста. Интерфейс хоста используется в процессе авторегистрации хоста. Если не определено, значение будет получено из HostInterfaceItem.
Агент выдаст ошибку и не запустится, если значение превышает предел в 255 символов.
Диапазон: 0–255 символов.
HostInterfaceItem
Необязательный параметр, определяющий элемент, используемый для получения интерфейса хоста.
Интерфейс хоста используется в процессе авторегистрации хоста. Эта опция используется только в том случае, если HostInterface не определен.
Элемент system.run[] поддерживается независимо от значений AllowKey/DenyKey.<br >Во время запроса на авторегистрацию агент записывает предупреждающее сообщение, если значение, возвращаемое указанным элементом, превышает ограничение в 255 символов.
HostMetadata
Необязательный параметр, определяющий метаданные хоста. Метаданные хоста используются только в процессе автоматической регистрации хоста. Если не определено, значение будет получено из HostMetadataItem.
Агент выдаст ошибку и не запустится, если указанное значение превышает предел в 2034 байта или строку, отличную от UTF-8.
Диапазон: 0–2034 байта.
HostMetadataItem
Необязательный параметр, определяющий элемент, используемый для получения метаданных хоста. Этот параметр используется только в том случае, если HostMetadata не определена. Поддерживаются пользовательские параметры и псевдонимы. Элемент system.run[] поддерживается независимо от значений AllowKey/DenyKey.
Значение HostMetadataItem извлекается при каждой попытке авторегистрации и используется только в процессе авторегистрации хоста.
Во время запроса на авторегистрацию агент записывает предупреждающее сообщение, если значение, возвращаемое указанным элементом, превышает предел в 65535 кодовых точек UTF-8. Значение, возвращаемое элементом, должно быть строкой UTF-8, иначе оно будет проигнорировано.
Hostname
Список уникальных имен хостов, разделенных запятыми, чувствительных к регистру. Требуется для активных проверок и должен соответствовать именам хостов, настроенным на сервере. Значение получается из HostnameItem, если оно не определено.
Допустимые символы: буквенно-цифровые, '.', ' ', '_' и '-'. Максимальная длина: 128 символов на имя хоста, 2048 символов на всю строку.
По умолчанию: устанавливается HostnameItem.
HostnameItem
Необязательный параметр, определяющий элемент, используемый для получения имени хоста. Эта опция используется только в том случае, если имя хоста не определено. Пользовательские параметры или псевдонимы не поддерживаются, но элемент system.run[] поддерживается независимо от значений AllowKey/DenyKey.
По умолчанию: system.hostname
Include
Вы можете включить отдельные файлы или все файлы в каталоге в файл конфигурации. Во время установки Zabbix создаст каталог include в /usr/local/etc, если он не был изменен во время компиляции. Путь может быть относительным к местоположению файла zabbix_agent2.conf.
Чтобы включить только соответствующие файлы в указанный каталог, для сопоставления с шаблоном поддерживается подстановочный знак звездочки.
См. специальные примечания об ограничениях.
Пример:
ListenIP
Список IP-адресов, разделенных запятыми, которые агент должен прослушивать. Первый IP-адрес отправляется на сервер Zabbix при подключении к нему для получения списка активных проверок.
По умолчанию: 0.0.0.0
ListenPort
Агент будет прослушивать этот порт на предмет соединений с сервером.
По умолчанию: 10050
Диапазон: 1024-32767
LogFile
Имя файла журнала агента.
По умолчанию: /tmp/zabbix_agent2.log
Обязательно: Да, если для LogType установлено значение file; иначе нет
LogFileSize
Максимальный размер файла журнала в МБ.
0 — отключить автоматическую ротацию журналов.
Примечание: если достигнут предел размера файла журнала и ротация файла по какой-либо причине не удалась, существующий файл журнала усекается и запускается заново.
По умолчанию: 1
Диапазон: 0–1024
Тип журнала
Тип вывода журнала:
file — запись журнала в файл, указанный параметром LogFile;
system — запись журнала в системный журнал;
console — запись журнала в стандартный вывод
По умолчанию: файл
PersistentBufferFile
Файл, в котором агент Zabbix 2 должен хранить базу данных SQLite. Должно быть полное имя файла. Этот параметр используется только в том случае, если постоянный буфер включен (EnablePersistentBuffer=1).
PersistentBufferPeriod
Период времени, в течение которого должны храниться данные при отсутствии соединения с сервером или прокси. Более старые данные будут потеряны. Данные журнала будут сохранены. Этот параметр используется только в том случае, если постоянный буфер включен (EnablePersistentBuffer=1).
По умолчанию: 1h
Диапазон: 1м-365д
PidFile
Имя PID-файла.
По умолчанию: /tmp/zabbix_agent2.pid
Plugins.<Имя плагина>.System.Capacity
Предел проверок для каждого плагина <Имя плагина>, который может выполняться одновременно.
По умолчанию: 100 Диапазон: 1-1000
Plugins.Log.MaxLinesPerSecond
Максимальное количество новых строк, которые агент будет отправлять в секунду на Zabbix-сервер или прокси-сервер при обработке активных проверок «log» и «logrt». Предоставленное значение будет переопределено параметром 'maxlines', указанным в ключах элементов 'log' и 'logrt'.
Примечание: Zabbix будет обрабатывать в 10 раз больше новых строк, чем установлено в MaxLinesPerSecond для поиска обязательная строка в элементах журнала.
По умолчанию: 20
Диапазон: 1-1000
Plugins.SystemRun.LogRemoteCommands
Включите регистрацию выполненных команд оболочки в виде предупреждений. Команды будут регистрироваться только в том случае, если они выполняются удаленно. Записи журнала не будут созданы, если system.run[] запускается локально с помощью параметров HostMetadataItem, HostInterfaceItem или HostnameItem.
По умолчанию: 0
Значения: 0 – отключено, 1 – включено
PluginSocket
Путь к сокету UNIX для связи с загружаемым плагином.
По умолчанию: /tmp/agent.plugin.sock
PluginTimeout
Таймаут соединений с загружаемыми плагинами, в секундах.
По умолчанию: Timeout
Диапазон: 1-30
Обновить активные проверки
Как часто обновляется список активных проверок (в секундах). Обратите внимание, что после неудачного обновления активных проверок следующая попытка обновления будет предпринята через 60 секунд.
По умолчанию: 5
Диапазон: 1-86400
Сервер
Список IP-адресов, разделенных запятыми, опционально в нотации CIDR, или DNS-имен серверов Zabbix или прокси-серверов Zabbix. Входящие соединения будут приниматься только от хостов, перечисленных здесь. Если поддержка IPv6 включена, то «127.0.0.1», «::127.0.0.1», «::ffff:127.0.0.1» обрабатываются одинаково, а «::/0» разрешает любой адрес IPv4 или IPv6. «0.0.0.0/0» можно использовать для разрешения любого адреса IPv4. Пробелы разрешены.
Пример:
Обязательно: да
ServerActive
Адрес Zabbix-сервера/прокси-сервера или конфигурация кластера для получения активных проверок. Адрес сервера/прокси — это IP-адрес или DNS-имя и необязательный порт, разделенные двоеточием.
Конфигурация кластера — это один или несколько адресов серверов, разделенных точкой с запятой. Можно указать несколько серверов/кластеров Zabbix и прокси-серверов Zabbix, разделив их запятой. Не следует указывать более одного прокси-сервера Zabbix для каждого сервера/кластера Zabbix. Если указан прокси-сервер Zabbix, то сервер/кластер Zabbix для этого прокси-сервера указывать не следует.
Можно указать несколько адресов, разделенных запятыми, для параллельного использования нескольких независимых серверов Zabbix. Допускаются пробелы.
Если порт не указан, используется порт по умолчанию.
Адреса IPv6 должны быть заключены в квадратные скобки, если указан порт для этого хоста. Если порт не указан, квадратные скобки для адресов IPv6 необязательны.
Если этот параметр не указан, активные проверки отключены.
Пример для Zabbix-прокси:
Пример для нескольких серверов:
Пример высокой доступности:
Пример высокой доступности с двумя кластерами и одним сервером:
ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domainIP-адрес источника
Исходный IP-адрес для:
- исходящих подключений к Zabbix-серверу или Zabbix-прокси;
- установления соединений при выполнении некоторых элементов (web.page.get, net.tcp.port и т. д.).
StatusPort
Если установлено, агент будет прослушивать этот порт на предмет запросов статуса HTTP (http://localhost:<port>/status).
Диапазон: 1024-32767
Timeout
Затрачивайте на обработку не более Timeout секунд.
По умолчанию: 3
Диапазон: 1-30
TLSAccept
Входящие соединения принять. Используется для пассивных проверок. Можно указать несколько значений, разделенных запятой:
unencrypted — принимать соединения без шифрования (по умолчанию)
psk — принимать соединения с TLS и предварительным общим ключом (PSK)
cert - принимать соединения с TLS и сертификатом
Обязательно: да, если определены сертификат TLS или параметры PSK (даже для нешифрованного соединения); иначе нет
#####TLSCAFile
Полный путь к файлу, содержащему сертификаты ЦС верхнего уровня для проверки одноранговых сертификатов, используемый для зашифрованной связи между компонентами Zabbix.
TLSCertFile
Полный путь к файлу, содержащему сертификат агента или цепочку сертификатов, используемый для зашифрованной связи с компонентами Zabbix.
TLSConnect
Как агент должен подключаться к Zabbix серверу или прокси. Используется для активных проверок. Можно указать только одно значение:
unencrypted — подключение без шифрования (по умолчанию)
psk — подключение с использованием TLS и предварительного общего ключа (PSK)
cert — подключение с использованием TLS и сертификат
Обязательно: да, если определены сертификат TLS или параметры PSK (даже для нешифрованного соединения); иначе нет
TLSCRLFile
Полный путь к файлу, содержащему отозванные сертификаты. Этот параметр используется для зашифрованной связи между компонентами Zabbix.
TLSKeyFile
Полный путь к файлу, содержащему закрытый ключ агента, используемый для зашифрованной связи между компонентами Zabbix.
#####TLSPSKFile
Полный путь к файлу, содержащему предварительный ключ агента, используемый для зашифрованной связи с сервером Zabbix.
TLSPSKIdentity
Строка идентификации предварительного общего ключа, используемая для зашифрованной связи с сервером Zabbix.
TLSServerCertIssuer
Разрешенный эмитент сертификата сервера (прокси).
TLSServerCertSubject
Разрешенный субъект сертификата сервера (прокси).
UnsafeUserParameters
Разрешить передачу всех символов в аргументах пользовательских параметров. Следующие символы не допускаются: \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
Кроме того, символы новой строки не допускаются.
По умолчанию: 0
Значения: 0 – не разрешать, 1 – разрешать
UserParameter
Определяемый пользователем параметр для мониторинга. Может быть несколько пользовательских параметров.
Формат: UserParameter=<ключ>,<команда оболочки>
Обратите внимание, что команда оболочки не должна возвращать пустую строку или только EOL. Команды оболочки могут иметь относительные пути, если указан параметр UserParameterDir.
Пример:
UserParameterDir
Путь поиска по умолчанию для команд UserParameter. Если используется, агент перед выполнением команды изменит свой рабочий каталог на указанный здесь. Таким образом, команды UserParameter могут иметь относительный префикс ./ вместо полного пути.
Допускается только одна запись.
Пример: