Параметры конфигурации: Zabbix агент

Обзор

Параметры конфигурации позволяют настраивать поведение агента Zabbix.

Укажите значения параметров в файле конфигурации (zabbix_agentd.conf). Все параметры необязательные, если явно не указано, что параметр является обязательным.

Эта страница имеет следующую структуру:

• Обзор параметров (чтобы увидеть полные сведения о параметре, нажмите на его имя)
• Сведения о параметрах

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

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

Сведения о параметре

Псевдоним

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

Пример 1: Получение ID пользователя 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: Запуск нескольких правил low-level discovery, обрабатывающих одни и те же элементы обнаружения.

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

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

AllowKey

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

AllowKeyRegexp

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

AllowRoot

Разрешает агенту запускаться от имени root. Если параметр отключен и агент запущен пользователем root, агент попытается переключиться на пользователя zabbix. Не имеет эффекта, если агент запущен обычным пользователем.

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

BufferSend

Установите частоту отправки значений из буфера на сервер/прокси Zabbix (в секундах).

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

BufferSize

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

По умолчанию: 100
Диапазон: 2-65535

DebugLevel

Установите уровень отладки:

• 0 - базовая информация о запуске и остановке процессов Zabbix;
• 1 - критическая информация;
• 2 - информация об ошибках;
• 3 - предупреждения;
• 4 - для отладки (выводит много информации);
• 5 - расширенная отладка (выводит еще больше информации).

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

DenyKey

Запрещает выполнение тех ключей элементов данных, которые соответствуют шаблону. Шаблон ключа представляет собой выражение с подстановочными знаками, которое поддерживает символ * для сопоставления с любым количеством любых символов.
Несколько правил сопоставления ключей могут быть определены в сочетании с AllowKey, AllowKeyRegexp и DenyKeyRegexp. Параметры обрабатываются по одному в порядке их появления. Порядок определяет, какое из совпадающих правил будет иметь приоритет. См. также: Ограничение проверок агента.

DenyKeyRegexp

Запрещает выполнение тех ключей элементов данных, которые соответствуют шаблону. Шаблон ключа — это регулярное выражение.
Несколько правил сопоставления ключей можно задавать в сочетании с AllowKeyRegexp, AllowKey и DenyKey. Параметры обрабатываются по одному в порядке их следования. Порядок определяет, какое из совпадающих правил будет иметь приоритет. См. также: Ограничение проверок агента.

EnableRemoteCommands

Разрешить удаленные команды от сервера Zabbix.
Этот параметр устарел, вместо него используйте AllowKey=system.run[*] или DenyKey=system.run[*].
Это внутренний псевдоним для параметров AllowKey/DenyKey в зависимости от значения:

• 0 - DenyKey=system.run[*]
• 1 - AllowKey=system.run[*]

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

HeartbeatFrequency

Установите частоту сообщений heartbeat в секундах. Используется для мониторинга доступности активных проверок.
0 - сообщения heartbeat отключены.

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

HostInterface

Укажите интерфейс узла сети (IP-адрес или DNS-имя), используемый во время авторегистрации узла сети. Это значение будет использовано для заполнения интерфейса в вновь созданном узле сети и позволяет явно настроить либо IP-, либо DNS-адрес. Подробнее см. Использование DNS в качестве интерфейса по умолчанию.

Если значение не задано, оно будет получено из HostInterfaceItem.

Агент выдаст ошибку и не запустится, если значение превышает лимит в 255 символов.

Диапазон: 0-255 символов

HostInterfaceItem

Укажите элемент данных, чтобы определить интерфейс узла сети (IP-адрес или DNS-имя) во время авторегистрации узла сети. Это значение используется только если HostInterface не определен. Подробнее см. Использование DNS в качестве интерфейса по умолчанию.

Во время запроса авторегистрации агент запишет предупреждение, если значение, возвращаемое указанным элементом данных, превышает лимит в 255 символов.

Элемент данных system.run[] поддерживается независимо от настроек AllowKey/DenyKey.

HostMetadata

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

Если не задано, значение будет получено из HostMetadataItem.

Агент выдаст ошибку и не запустится, если указанное значение превышает лимит в 2034 байта или представляет собой строку не в кодировке UTF-8. Когда параметр ожидает IP-адрес или DNS-имя, значения, которые являются допустимыми UTF-8, но не являются допустимыми IP-адресами или DNS-именами, также будут отклонены и помечены как недопустимые.

Многострочные метаданные не поддерживаются — вывод будет обрезан на первом разрыве строки.

Диапазон: 0-2034 байта

HostMetadataItem

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

Значение HostMetadataItem извлекается при каждой попытке авторегистрации и используется только в процессе авторегистрации узла сети (активный агент). HostMetadataItem позволяет различать узлы сети не только по имени хоста.

Поддерживаются пользовательские параметры и псевдонимы. Элемент system.run[] поддерживается независимо от настроек AllowKey/DenyKey.

Во время запроса авторегистрации агент запишет предупреждение, если значение, возвращенное указанным элементом данных, превышает лимит в 65535 кодовых точек UTF-8. Значение, возвращаемое элементом данных, должно быть строкой UTF-8, иначе оно будет проигнорировано. Если параметр ожидает IP-адрес или DNS-имя, значения, которые являются допустимыми UTF-8, но не являются допустимыми IP-адресами или DNS-именами, также будут отклонены и помечены как недопустимые.

Многострочные метаданные не поддерживаются — вывод будет обрезан на первом символе разрыва строки.

Имя узла сети

Укажите уникальные имена узлов сети с учетом регистра. Список, разделенный запятыми.
Требуется для активных проверок и должен совпадать с именами узлов сети, настроенными на сервере.
Значение берется из HostnameItem, если оно не задано.
Допустимые символы: буквенно-цифровые, '.', ' ', '_' и '-'. Максимальная длина: 128 символов на каждое имя узла сети, 2048 символов для всей строки.

По умолчанию: задается HostnameItem

HostnameItem

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

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

Включение

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

Пример:

Include=/absolute/path/to/config/files/*.conf

ListenBacklog

Установите максимальное число ожидающих соединений в очереди TCP.
Значение по умолчанию — жестко заданная константа, которая зависит от системы.
Максимально поддерживаемое значение также зависит от системы; слишком большие значения могут быть незаметно усечены до 'implementation-specified maximum'.

По умолчанию: SOMAXCONN
Диапазон: 0 - INT_MAX

ListenIP

Укажите IP-адрес, на котором агент принимает подключения от сервера/прокси. Список значений, разделенных запятыми.

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

ListenPort

Укажите порт прослушивания агента для подключений от сервера/прокси.

По умолчанию: 10050
Диапазон: 1024-32767

LoadModule

Укажите модуль, который нужно загрузить при запуске агента.
Модули используются для расширения функциональности агента.
Модуль должен находиться в каталоге, указанном в LoadModulePath, либо путь должен предшествовать имени модуля. Если указанный путь является абсолютным (начинается с /), то LoadModulePath игнорируется.
Форматы:

• LoadModule=<module.so>
• LoadModule=<path/module.so>
• LoadModule=</abs_path/module.so>

Допускается указывать несколько параметров LoadModule.

LoadModulePath

Укажите полный путь к расположению модулей агента.
Значение по умолчанию зависит от параметров компиляции.

LogFile

Укажите файл журнала агента.

Обязательно: Да, если LogType установлен в file; в противном случае — нет

LogFileSize

Установите максимальный размер файла журнала (в МБ).
0 - отключить автоматическую ротацию журнала.
Примечание: Если достигается ограничение размера файла журнала и ротация файла по какой-либо причине не выполняется, существующий файл журнала усекается и создается заново.

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

LogRemoteCommands

Включить журналирование выполненных команд оболочки как предупреждений.
Команды будут записываться в журнал только при удаленном выполнении.
Записи в журнале не будут создаваться, если system.run[] запускается локально параметрами HostMetadataItem, HostInterfaceItem или HostnameItem.

По умолчанию: 0
Значения: 0 - отключено, 1 - включено

LogType

Укажите тип вывода журнала:

• file - записывать журнал в файл, указанный параметром LogFile;
• system - записывать журнал в syslog;
• console - записывать журнал в стандартный вывод.

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

MaxLinesPerSecond

Установите максимальное количество новых строк в секунду для отправки на сервер/прокси Zabbix при обработке активных проверок log или logrt.
Указанное значение будет переопределено параметром maxlines, заданным в ключе элемента данных log или logrt.
Примечание: Zabbix будет обрабатывать в 10 раз больше новых строк, чем задано в MaxLinesPerSecond, чтобы найти требуемую строку в элементах данных журнала.

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

PidFile

Укажите PID-файл.

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

RefreshActiveChecks

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

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

Сервер

Укажите IP-адреса, при необходимости в нотации CIDR, или DNS-имена серверов/прокси Zabbix. Список, разделенный запятыми.
Входящие подключения будут приниматься только от узлов сети, перечисленных здесь. Если поддержка IPv6 включена, то 127.0.0.1, ::127.0.0.1, ::ffff:127.0.0.1 обрабатываются одинаково, и ::/0 позволит любой IPv4- или IPv6-адрес. 0.0.0.0/0 можно использовать, чтобы разрешить любой IPv4-адрес. Обратите внимание, что "IPv4-compatible IPv6 addresses" (0000::/96 prefix) поддерживаются, но устарели согласно RFC4291. Допускаются пробелы.

Пример:

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

Обязательно: да, если StartAgents явно не задано в 0

ServerActive

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

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

ServerActive=127.0.0.1:10051

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

ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com

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

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

SourceIP

Укажите исходящий IP-адрес для:

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

StartAgents

Установите количество предварительно созданных экземпляров zabbix_agentd для обработки пассивных проверок.
Если установлено значение 0, пассивные проверки отключаются, и агент не будет прослушивать какой-либо TCP-порт.

По умолчанию: 10
Диапазон: 0-100

Таймаут

Укажите, сколько времени ожидать (в секундах) установления соединения и обмена данными с прокси или сервером Zabbix.

Этот параметр определяет длительность различных операций связи, включая:

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

Этот таймаут не будет использоваться для тех проверок агента, для которых на веб-интерфейсе заданы настраиваемые параметры таймаута (на глобальном уровне, уровне прокси или на уровне отдельного элемента данных).

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

TLSAccept

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

• unencrypted - принимать подключения без шифрования (по умолчанию);
• psk - принимать подключения с TLS и предварительно общим ключом (PSK);
• cert - принимать подключения с TLS и сертификатом.

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

TLSCAFile

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

TLSCertFile

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

TLSCipherAll

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

Пример:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherAll13

Укажите строку шифров для OpenSSL 1.1.1 или более новой версии в TLS 1.3. Переопределяет критерии выбора набора шифров по умолчанию для шифрования на основе сертификатов и PSK.

Пример для GnuTLS:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509

Пример для OpenSSL:

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

TLSCipherCert

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

Пример для GnuTLS:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509

Пример для OpenSSL:

EECDH+aRSA+AES128:RSA+aRSA+AES128

TLSCipherCert13

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

TLSCipherPSK

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

Пример для GnuTLS:

NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL

Пример для OpenSSL:

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

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

Пример:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSConnect

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

• unencrypted - подключение без шифрования (по умолчанию);
• psk - подключение с использованием TLS и предварительно общего ключа (PSK);
• cert - подключение с использованием TLS и сертификата.

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

TLSCRLFile

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

TLSKeyFile

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

TLSPSKFile

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

TLSPSKIdentity

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

TLSServerCertIssuer

Укажите разрешенного издателя сертификата сервера (прокси).

TLSServerCertSubject

Укажите допустимый subject сертификата сервера (прокси).

UnsafeUserParameters

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

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

Пользователь

Снижает привилегии до конкретного существующего пользователя в системе.
Имеет эффект только при запуске от root, если AllowRoot отключен.

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

UserParameter

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

Пример:

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

UserParameterDir

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

Пример:

UserParameterDir=/opt/myscripts

См. также

1. Различия в конфигурации агента Zabbix для активных и пассивных проверок, начиная с версии 2.0.0