4. Zabbix агент 2 (UNIX)

Обзор

Zabbix агент 2 — новое поколение Zabbix агента и может использоваться в качестве замены Zabbix агента.

В этом разделе перечислены параметры, поддерживаемые в файле конфигурации Zabbix агента 2 (zabbix_agent2.conf).

Параметры перечислены без подробных сведений. Нажмите на параметр, чтобы увидеть полную информацию.

Все параметры являются необязательными, если явно не оговорено, что параметр обязателен.

Обратите внимание:

• Значения по умолчанию отражают значения по умолчанию самого демона, а не значения в поставляемых файлах конфигурации;
• Zabbix поддерживает файлы конфигурации только в кодировке UTF-8 без BOM;
• Комментарии, начинающиеся с «#», поддерживаются только в начале строки.

Подробности параметра

Alias

Задаёт алиас для ключа элемента данных. Его можно использовать для замены длинных и сложных ключей элементов данных на более короткие и простые.
Можно добавлять несколько параметров Alias. Несколько параметров с одинаковым ключом Alias не разрешены.
Различные ключи параметра Alias могут ссылаться на тот же ключ элемента данных.
Алиасы можно использовать в параметре HostMetadataItem, но нельзя в параметре HostnameItem.

Пример 1: Получение числового идентификатора пользователя «zabbix».

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

Теперь для получения данных можно использовать сокращённый ключ zabbix.userid.

Пример 2: Получение утилизации CPU с параметрами по умолчанию и с пользовательскими параметрами.

Alias=cpu.util:system.cpu.util
       Alias=cpu.util[*]:system.cpu.util[*]

Такая запись позволяет использовать ключ cpu.util для получения утилизации CPU в процентах с параметрами по умолчанию, а также использовать cpu.util[all, idle, avg15] для получения конкретных данных об утилизации CPU.

Пример 3: Выполнение нескольких правил низкоуровневого обнаружения, которые обрабатывают одни и те же элементы данных обнаружения.

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

Теперь имеется возможность настроить несколько правил обнаружения, используя vfs.fs.discovery с разными параметрами для каждого правила, например, vfs.fs.discovery[foo], vfs.fs.discovery[bar] и т.д.

AllowKey

Разрешение выполнения тех ключей элементов данных, которые соответствуют шаблону. Шаблон ключа — это выражение с подстановочным знаком, которое поддерживает символ «*» для соответствия с любым количеством любых символов.
Можно задать несколько правил соответствия ключей в сочетании с DenyKey. Параметры обрабатываются по очереди в соответствии с порядком их появления. Смотрите также: Ограничение проверок агента.

BufferSend

Интервал времени в секундах, определяющий, как часто значения из буфера отсылаются на Zabbix сервер. Обратите внимание, что если буфер заполнен, данные будут отосланы раньше.

По умолчанию: 5
Диапазон: 1-3600

BufferSize

Максимальное количество значений в буфере памяти. При заполнении буфера агент будет отправлять все собранные данные Zabbix серверу или прокси. Этот параметр должен использоваться только если постоянный буфер отключён (EnablePersistentBuffer=0).

По умолчанию: 1000
Диапазон: 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 — включено

Частота сердцебиения

Частота контрольных сообщений (heartbeat) в секундах. Используется для контроля доступности активных проверок.
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 не определён. Поддерживаются UserParameters и алиасы. Элемент данных system.run[] поддерживается независимо от значений параметров AllowKey/DenyKey.
Значение HostMetadataItem извлекается на каждую попытку авторегистрации и используется только в процессе автоматической регистрации узлов сети.
При запросе на авторегистрацию агент запишет в журнал предупреждение, если полученное от указанного элемента данных значение превышает ограничение в 65535 кодовых позиций (code points) UTF-8. Значение, возвращаемое указанным элементом данных, должно являться UTF-8 строкой, в противном случае оно будет игнорироваться.

Hostname

Список (через запятую) уникальных, регистрозависимых имён узла сети. Требуется для активных проверок и должно совпадать с именами узла сети, указанными на сервере. Если не задано, значение будет браться из HostnameItem.
Допустимые символы: алфавитно-цифровые, «.», « », «_» и «-». Максимальная длина: 128 символов на имя узла сети, 2048 символов для всей строки.

По умолчанию: Задаётся параметром HostnameItem

HostnameItem

Опциональный параметр, который задаёт элемент данных Zabbix агента, используемый для получения имени узла сети. Этот параметр используется, только если Hostname не определён. Не поддерживает UserParameters или алиасы, но поддерживает system.run[], независимо от значений AllowKey/DenyKey.

По умолчанию: system.hostname

Include

Вы можете включить отдельные файлы или все файлы в каталоге в файл конфигурации. В процессе инсталляции Zabbix создаст директорию для включения файлов в /usr/local/etc, если только она не была изменена во время компиляции. Путь может быть относительным по отношению к местоположению файла zabbix_agent2.conf.
Чтобы включить в указанный каталог только соответствующие файлы, для сопоставления с шаблоном поддерживается подстановочный знак звёздочки.
Смотрите специальные примечания по поводу ограничений.

Пример:

Include=/абсолютный/путь/к/конфиг/файлам/*.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 — запись журнала в syslog;
console — вывод журнала в стандартный вывод.

По умолчанию: file

PersistentBufferFile

Файл, в котором Zabbix агент 2 должен хранить базу данных SQLite. Имя файла должно быть указано с абсолютным путём. Этот параметр используется, только если включён постоянный буфер (EnablePersistentBuffer=1).

PersistentBufferPeriod

Период времени, в течение которого должны храниться данные, когда нет соединения с сервером или прокси. Более старые данные будут потеряны. Журнальные данные будут сохранены. Этот параметр используется, только если включён постоянный буфер (EnablePersistentBuffer=1).

По умолчанию: 1h
Диапазон: 1m-365d

PidFile

Имя PID файла.

По умолчанию: /tmp/zabbix_agent2.pid

Plugins.<ИмяПлагина>.System.Capacity

Ограничение количества проверок на плагин <ИмяПлагина>, которые могут выполняться одновременно.

По умолчанию: 1000 Диапазон: 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

RefreshActiveChecks

Как часто обновлять список активных проверок, в секундах. Обратите внимание, что после неуспешного обновления активных проверок, следующая попытка будет предпринята через 60 секунд.

По умолчанию: 5
Диапазон: 1-86400

Server

Список (через запятую) 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 адрес. Пробелы разрешены. Если этот параметр не указан, пассивные проверки отключаются, и агент не будет прослушивать ни один порт TCP.

Пример:

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

ServerActive

Адрес Zabbix сервера/прокси или конфигурация кластера для получения активных проверок. Адрес сервера/прокси — это IP адрес или DNS имя и опционально порт, разделённые двоеточием.
Конфигурация кластера — один или более адресов серверов, разделённые символом «точка с запятой». Можно указать несколько серверов/кластеров/прокси Zabbix, разделяя их запятой. От каждого сервера/кластера Zabbix должно быть указано не более одного Zabbix прокси. Если указан Zabbix прокси, то сервер/кластер Zabbix для этого прокси не должны быть указаны.
Несколько адресов через запятую можно указать для использования нескольких независимых серверов Zabbix параллельно. Пробелы разрешены.
Если порт не указан, используется порт по умолчанию.
Адреса IPv6 должны быть заключены в квадратные скобки, если для этого хоста указан порт. Если порт не указан, квадратные скобки для адресов IPv6 опциональны.
Если этот параметр не указан, активные проверки отключены.

Пример для Zabbix прокси:

ServerActive=127.0.0.1:10051

Пример для нескольких серверов:

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

Пример для кластера высокой доступности:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

Пример для конфигурации высокой доступности с двумя кластерами и одним сервером:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain

IP-адрес источника

Локальный IP адрес для:
- исходящих подключений к Zabbix серверу или прокси;
- создания подключений при выполнении некоторых элементов данных (web.page.get, net.tcp.port и т.п.).

StatusPort

Если задан, агент будет слушать указанный порт для HTTP запросов состояния (http://localhost:<порт>/status).

Диапазон: 1024-32767

Timeout

Указывает, как долго (в секундах) следует ожидать установления соединения и обмена данными с Zabbix сервером или прокси.
Этот параметр определяет продолжительность различных операций, в том числе:

• ожидание ответа от Zabbix сервера;
• отправку запросов на Zabbix сервер, в том числе запросы конфигурации активных проверок и значения элементов данных;
• получение данных журнала посредством мониторинга файла журнала или журнала событий Windows;
• отправка сообщений heartbeat;
• максимальная длительность для проверок vfs.*;
• служит в качестве запасного варианта в сценариях, где сервер или прокси версии старше 7.0 отправляет проверки без тайм-аутов.

По умолчанию: 3
Диапазон: 1-30

TLSAccept

Какие входящие соединения принимать. Используется для пассивных проверок. Можно указать несколько значений через запятую:
unencrypted — принимать соединения без шифрования (по умолчанию)
psk — принимать подключения с TLS и общим ключом (pre-shared key, PSK)
cert — принимать подключения с TLS и сертификатом

Обязательное: да, если заданы TLS сертификат или параметры PSK (даже для незашифрованных подключений), в противном случае — нет

TLSCAFile

Абсолютный путь к файлу, который содержит сертификаты удостоверяющих центров (certificate authority, CA) верхнего уровня для проверки сертификата узла, используется для зашифрованных соединений между компонентами Zabbix.

TLSCertFile

Абсолютный путь к файлу, который содержит сертификат агента или цепочку сертификатов, используется для зашифрованных соединений между компонентами Zabbix.

TLSCipherAll

Строка шифров OpenSSL (TLS 1.2). Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе сертификатов и общего ключа (PSK).

Пример:

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128

Этот параметр поддерживается, начиная с Zabbix 7.0.4.

TLSCipherAll13

Строка шифров OpenSSL (TLS 1.3) для OpenSSL 1.1.1 или новее. Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе сертификатов и общего ключа (PSK).

Пример:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

Этот параметр поддерживается, начиная с Zabbix 7.0.4.

TLSCipherCert

Строка шифров OpenSSL (TLS 1.2). Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе сертификатов.

Пример:

EECDH+aRSA+AES128:RSA+aRSA+AES128

Обратите внимание, что этот параметр нельзя использовать вместе с TLSAccept=cert,psk; для подключения с использованием сертификата (TLSConnect=cert) используйте вместо этого TLSCipherAll.

Этот параметр поддерживается, начиная с Zabbix 7.0.4.

TLSCipherCert13

Строка шифров OpenSSL (TLS 1.3) для OpenSSL 1.1.1 или новее. Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе сертификатов.

Обратите внимание, что этот параметр нельзя использовать вместе с TLSAccept=cert,psk; для подключения с использованием сертификата (TLSConnect=cert) используйте вместо этого TLSCipherAll13.

Этот параметр поддерживается, начиная с Zabbix 7.0.4.

TLSCipherPSK

Строка шифров OpenSSL (TLS 1.2). Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе общего ключа (PSK).

Пример:

kECDHEPSK+AES128:kPSK+AES128

Этот параметр поддерживается, начиная с Zabbix 7.0.4.

TLSCipherPSK13

Строка шифров для OpenSSL (TLS 1.3) для OpenSSL 1.1.1 или новее. Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе общего ключа (PSK).

Пример:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

Этот параметр поддерживается, начиная с Zabbix 7.0.4.

TLSConnect

Как агент должен подключаться к Zabbix серверу или прокси. Используется для активных проверок. Можно указать только одно значение:
unencrypted — подключаться без шифрования (по умолчанию)
psk — подключаться, используя TLS и общий ключ (pre-shared key, PSK)
cert — подключаться, используя TLS и сертификат

Обязательное: да, если заданы TLS сертификат или параметры PSK (даже при незашифрованном соединении), в противном случае — нет

TLSCRLFile

Абсолютный путь к файлу, содержащему отозванные сертификаты. Этот параметр используется для зашифрованных коммуникаций между компонентами Zabbix.

TLSKeyFile

Абсолютный путь к файлу, содержащему закрытый ключ агента (private key), используется для зашифрованных коммуникаций между компонентами Zabbix.

TLSPSKFile

Абсолютный путь к файлу, содержащему общий ключ (pre-shared key) агента. Используется для зашифрованных коммуникаций с сервером Zabbix.

TLSPSKIdentity

Строка идентификатора PSK, используется для зашифрованных соединений с Zabbix сервером.

TLSServerCertIssuer

Разрешённый эмитент сертификата сервера (прокси).

TLSServerCertSubject

Разрешённый субъект сертификата сервера (прокси).

UnsafeUserParameters

Разрешить передавать аргументами в пользовательские параметры все символы. Не разрешены следующие символы: \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
Кроме того, не разрешены символы новой строки.

По умолчанию: 0
Значения: 0 — не разрешать, 1 — разрешить

UserParameter

Пользовательский параметр для мониторинга. Можно указать несколько пользовательских параметров.
Формат: UserParameter=<ключ>,<команда оболочки>
Обратите внимание, что команда не должна возвращать только пустую строку или EOL. Команды оболочки могут иметь относительные пути, если указан параметр UserParameterDir.

Пример:

UserParameter=system.test,who|wc -l
       UserParameter=check_cpu,./custom_script.sh

UserParameterDir

Путь поиска по умолчанию для команд UserParameter. Если используется, агент перед выполнением команды сменит свою рабочую директорию на указанную здесь. Таким образом, команды UserParameter могут иметь относительный префикс ./ вместо полного пути.
Допустимо только одно значение.

Пример:

UserParameterDir=/opt/myscripts