4 Zabbix агент (Windows)

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

Поддерживаемые параметры в файле конфигурации Zabbix агента (Windows):

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

Примеры:

1. Получение с сервера использования файла подкачки в процентах:
Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]
Теперь можно использовать сокращенный ключ pg_usage, чтобы получать данные.

2. Получение загрузки CPU с параметрами по умолчанию и с пользовательскими параметрами.
Alias=cpu.load:system.cpu.load
Alias=cpu.load[*]:system.cpu.load[*]
Такая запись позволяет использовать cpu.load ключ для получения утилизации CPU в процентах с параметрами по умолчанию, а также использовать cpu.load[percpu,avg15] для получения конкретных данных о загрузке CPU.

3. Выполнение нескольких правил низкоуровневого обнаружения, которые обрабатывают одни и те же элементы данных обнаружения.
Alias=vfs.fs.discovery[*]:vfs.fs.discovery
Теперь имеется возможность добавить несколько правил обнаружения, используя vfs.fs.discovery с разными параметрами для каждого правила, например, vfs.fs.discovery[foo], vfs.fs.discovery[bar], и т.д.
BufferSend нет 1-3600 5 Не хранить данные в буфере дольше N секунд.
BufferSize нет 2-65535 100 Максимальное количество значений в буфере памяти. Агент будет отправлять
все собранные данные Zabbix серверу или прокси при заполнении буфера.
DebugLevel нет 0-5 3 Задает уровень журналирования:
0 - основная информация о запуске и остановки процессов Zabbix
1 - критичная информация
2 - информация об ошибках
3 - предупреждения
4 - для отладки (записывается очень много информации)
5 - расширенная отладка (записывается еще больше информации)
EnableRemoteCommands нет 0 Разрешены ли удаленные команды с Zabbix сервера.
0 - не разрешены
1 - разрешены
HostMetadata нет 0-255 символов Опциональный параметр, который задает метаданные узла сети. Метаданные узла сети используются только в процессе автоматической регистрации узлов сети (активный агент).
Если не определено, то значение берётся от HostMetadataItem.
Агент выдаст ошибку и не запустится, если указанное значение выходит за лимит длины строки или не является UTF-8 строкой.
Этот параметр поддерживается с версии 2.2.0 и выше.
HostMetadataItem нет Опциональный параметр, который задает элемент данных Zabbix агент, который используется для получения метаданных узла сети. Этот параметр используется только, если HostMetadata не определен.
Поддерживаются UserParameters и алиасы. Поддерживается system.run[] независимо от значения EnableRemoteCommands.
Значение HostMetadataItem поступает при каждой попытке авто-регистрации и используется только в процессе автоматической регистрации узлов сети (активный агент).
В процессе запроса авторегистрации агент запишет в журнал предупреждающее сообщение, если полученное значение от указанного элемента данных выходит за лимит в 255 символов.
Значение полученное от указанного элемента данных должно являться UTF-8 строкой, в противном случае оно будет игнорироваться.
Этот параметр поддерживается с версии 2.2.0 и выше.
Hostname нет Задается HostnameItem'ом Уникальное, регистрозависимое имя хоста.
Требуется для активных проверок и должно совпадать с именем узла сети указанном на сервере.
Допустимые символы: буквенно-цифровые, '.', ' ', '_' и '-'.
Максимальная длина: 64
HostnameItem нет system.hostname Опциональный параметр, который задает элемент данных Zabbix агент, который используется для получения имени хоста. Этот параметр используется только, если Hostname не определен.
Не поддерживает UserParameters, счетчики производительности и алиасы, но поддерживает system.run[], независимо от значения EnableRemoteCommands.
Этот параметр поддерживается с версии 1.8.6 и более новыми.
Смотрите также более детальное описание.
Include нет Вы можете включить отдельные файлы или все файлы из папки с файлом конфигурации.
Для включения только необходимых файлов из указанной папки, поддерживается символ звездочки для поиска совпадения по маске. Например: /абсолютный/путь/к/файлам/конфигурации/*.conf. Совпадение с маской поддерживается начиная с Zabbix 2.4.0.
Смотрите специальные заметки по поводу ограничений.
ListenIP нет 0.0.0.0 Список IP адресов, разделенных запятой, на которых агент должен слушать.
Несколько IP адресов поддерживаются начиная с Zabbix 1.8.3.
ListenPort нет 1024-32767 10050 Агент будет слушать этот порт для подключений с сервера.
LogFile да, если LogType задан как file, иначе
нет.
C:\zabbix_agentd.log Имя файла журнала агента.
LogFileSize нет 0-1024 1 Максимальный размер файла журнала в МБ.
0 - отключение автоматической ротации журнала.
Примечание: Если лимит достигнут и ротация не удалась, по каким-либо причинам, существующий файл журнала очищается и начинается новый.
LogType нет file Тип вывода журнала:
file - запись журнала в файл указанный в LogFile параметре,
system - запись журнала в Журнал событий Windows,
console - вывод журнала в стандартный вывод.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
LogRemoteCommands нет 0 Включение журналирования выполняемых shell команд как предупреждений.
0 - отключено
1 - включено
MaxLinesPerSecond нет 1-1000 20 Максимальное количество новых строк в секунду, которые агент будет отправлять серверу или прокси при обработке активных проверок 'log', 'logrt' и 'eventlog'.
Указаное значение будет перезаписано параметром 'maxlines',
указанное в ключах элементов данных 'log', 'logrt' и 'eventlog'.
Обратите внимание: Zabbix будет обрабатывать в 10 раз больше новых строк, чем указано в MaxLinesPerSecond при поиске требуемой строки в элементах данных журналов.
PerfCounter нет Синтаксис: <имя_параметра>,"<путь_к_счетчику_производительности>",<период>
Определяет новый параметр <имя_параметра>, который является усредненным значением < путь_к_счетчику_производительности > счетчика производительности системы за указанный период времени <период> (в секундах).
Например, если хотите получать среднее количество прерываний процессора в секунду за последнюю минуту, вы можете задать новый параметр "interrupts", как:
PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60
Пожалуйста, обратите внимание на двойные кавычки вокруг пути счетчика производительности.
Имя параметра (interrupts) используется как ключ элемента данных, при создании элемента данных.
Образцы для вычисления среднего значения берутся каждую секунду.
Вы можете выполнить "typeperf -qx", чтобы получить список всех счетчиков производительности доступных в Windows.
PerfCounterEn нет Синтаксис: <имя_параметра>,"<путь_к_счетчику_производительности>",<период>
Определяет новый параметр <имя_параметра>, который является усредненным значением < путь_к_счетчику_производительности > счетчика производительности системы за указанный период времени <период> (в секундах).
В сравнении с PerfCounter, пути к счётчикам производительности должны быть указаны на Английском языке.
Поддерживается только на Windows Server 2008/Vista и более новых версиях.
Например, если хотите получать среднее количество прерываний процессора в секунду за последнюю минуту, вы можете задать новый параметр "interrupts", как:
PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60
Пожалуйста, обратите внимание на двойные кавычки вокруг пути счетчика производительности.
Имя параметра (interrupts) используется как ключ элемента данных, при создании элемента данных.\
Образцы для вычисления среднего значения берутся каждую секунду.
Вы можете найти список строк на Английском языке, заглянув в следующую ветку реестра: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.
Этот параметр поддерживается начиная с Zabbix 4.0.13.
RefreshActiveChecks нет 60-3600 120 Как часто обновлять список активных проверок, в секундах.
Обратите внимание, что после неуспешного обновления активных проверок, следующая попытка будет предпринята через 60 секунд.
Server да, если StartAgents задано значением 0 явно Список разделенных запятой IP адресов, опционально в CIDR нотации, или имен хостов 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-совместимые IPv6 адреса" (0000::/96 prefix) поддерживаются, но являются устаревшими согласно RFC4291 [en].
Пример: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.domain
Пробелы допускаются.
ServerActive нет (*) Список пар IP:порт (или имя хоста:порт) Zabbix серверов или Zabbix прокси для активных проверок.
Можно указывать несколько адресов разделенных запятыми, чтобы параллельно использовать несколько независимых Zabbix серверов. Пробелы допускаются.
Если порт не указан, то используется порт по умолчанию.
IPv6 адреса должны быть заключены в квадратные скобки, если для хоста указывается порт.
Если порт порт не указан, то квадратные скобки для IPv6 адресов опциональны.
Если параметр не указан, активные проверки отключены.
SourceIP нет Локальный IP адрес для исходящих подключений.
StartAgents нет 0-63 (*) 3 Количество пре-форков экземпляров zabbix_agentd, которые обрабатывают пассивные проверки.
Если указано значение равное 0, то пассивные проверки будут отключены и агент не будет слушать какой-либо TCP порт.
Максимальное количество 16 до версии 1.8.5.
Timeout нет 1-30 3 Тратить не более Timeout секунд при обработке
TLSAccept да, если заданы TLS сертификат или параметры PSK (даже при незашифрованном соединении), в противном случае - нет Какие принимаются входящие подключения. Используется пассивными проверками. Можно указывать несколько значений, разделенных запятой:
unencrypted - принимать подключения без шифрования (по умолчанию)
psk - принимать подключения с TLS и pre-shared ключем (PSK)
cert - принимать подключения с TLS и сертификатом
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSCAFile нет Абсолютный путь к файлу, который содержит сертификаты верхнего уровня CA(и) для верификации сертификата узла, используется для зашифрованных соединений между Zabbix компонентами.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSCertFile нет Абсолютный путь к файлу, который содержит сертификат или цепочку сертификатов, используется для зашифрованных соединений между Zabbix компонентами.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSConnect да, если заданы TLS сертификат или параметры PSK (даже при незашифрованном соединении), в противном случае - нет Как агент должен соединяться с Zabbix сервером или прокси. Используется активными проверками. Можно указать только одно значение:
unencrypted - подключаться без шифрования (по умолчанию)
psk - подключаться, используя TLS и pre-shared ключем (PSK)
cert - подключаться, используя TLS и сертификат
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSCRLFile нет Абсолютный путь к файлу, который содержит отозванные сертификаты. Этот параметр используется для зашифрованных соединений между Zabbix компонентами.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSKeyFile нет Абсолютный путь к файлу, который содержит приватный ключ агента, используется для зашифрованных соединений между Zabbix компонентами.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSPSKFile нет Абсолютный путь к файлу, который содержит pre-shared ключ агента, используется для зашифрованных соединений с Zabbix сервером.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSPSKIdentity нет Строка идентификатор pre-shared ключа, используется для зашифрованных соединений с Zabbix сервером.
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSServerCertIssuer нет Разрешенный эмитент сертификата сервера (прокси).
Этот параметр поддерживается начиная с Zabbix 3.0.0.
TLSServerCertSubject нет Разрешенная тема сертификата сервера (прокси).
Этот параметр поддерживается начиная с Zabbix 3.0.0.
UnsafeUserParameters нет 0,1 0 Разрешить все символы, которые можно передать аргументами в пользовательские параметры.
0 - не разрешать
1 - разрешать
Не разрешены следующие символы:
\ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
Кроме того, не разрешены символы новой строки.
UserParameter Пользовательский параметр для мониторинга. Можно указать нескольких пользовательских параметров.
Формат: UserParameter=<ключ>,<shell команда>
Обратите внимание, что команда не должна возвращать только пустую строку или EOL.
Например: UserParameter=system.test,echo 1

(*) Количество активных серверов, перечисленных в ServerActive, плюс количество пре-форк экземпляров для пассивных проверок, указанных в StartAgents, должно быть меньше 64.

В Zabbix агенте версии 2.0.0 параметры конфигурации связанные с активными и пассивными проверками изменены.
Смотрите раздел "Смотрите также" внизу этой страницы для получения более подробных сведений об эти изменениях.

Zabbix поддерживает файлы конфигурации только в кодировке UTF-8 без BOM.

Комментарии, начинающиеся с "#", поддерживаются только в начале строки.

Смотрите также

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

Parameters

Parameter Mandatory Range Default Description
Alias no Sets an alias for an item key. It can be used to substitute long and complex item key with a smaller and simpler one.
Multiple Alias parameters may be present. Multiple parameters with the same Alias key are allowed.
Different Alias keys may reference the same item key.
Aliases can be used in HostMetadataItem but not in HostnameItem or PerfCounter parameters.

Examples:

1. Retrieving paging file usage in percents from the server.
Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]
Now shorthand key pg_usage may be used to retrieve data.

2. Getting CPU load with default and custom parameters.
Alias=cpu.load:system.cpu.load
Alias=cpu.load[*]:system.cpu.load[*]
This allows use cpu.load key to get CPU utilization percentage with default parameters as well as use cpu.load[percpu,avg15] to get specific data about CPU load.

3. Running multiple low-level discovery rules processing the same discovery items.
Alias=vfs.fs.discovery[*]:vfs.fs.discovery
Now it is possible to set up several discovery rules using vfs.fs.discovery with different parameters for each rule, e.g., vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc.
BufferSend no 1-3600 5 Do not keep data longer than N seconds in buffer.
BufferSize no 2-65535 100 Maximum number of values in a memory buffer. The agent will send
all collected data to Zabbix server or proxy if the buffer is full.
DebugLevel no 0-5 3 Specifies debug level:
0 - basic information about starting and stopping of Zabbix processes
1 - critical information
2 - error information
3 - warnings
4 - for debugging (produces lots of information)
5 - extended debugging (produces even more information)
EnableRemoteCommands no 0 Whether remote commands from Zabbix server are allowed.
0 - not allowed
1 - allowed
HostMetadata no 0-255 characters Optional parameter that defines host metadata. Host metadata is used only at host auto-registration process (active agent).
If not defined, the value will be acquired from HostMetadataItem.
An agent will issue an error and not start if the specified value is over the limit or a non-UTF-8 string.
This option is supported in version 2.2.0 and higher.
HostMetadataItem no Optional parameter that defines a Zabbix agent item used for getting host metadata. This option is only used when HostMetadata is not defined.
Supports UserParameters, performance counters and aliases. Supports system.run[] regardless of EnableRemoteCommands value.
HostMetadataItem value is retrieved on each auto-registration attempt and is used only at host auto-registration process (active agent).
During an auto-registration request an agent will log a warning message if the value returned by the specified item is over the limit of 255 characters.
The value returned by the item must be a UTF-8 string otherwise it will be ignored.
This option is supported in version 2.2.0 and higher.
Hostname no Set by HostnameItem Unique, case sensitive hostname.
Required for active checks and must match hostname as configured on the server.
Allowed characters: alphanumeric, '.', ' ', '_' and '-'.
Maximum length: 64
HostnameItem no system.hostname Optional parameter that defines a Zabbix agent item used for getting host name. This option is only used when Hostname is not defined.
Does not support UserParameters, performance counters or aliases, but does support system.run[] regardless of EnableRemoteCommands value.
This option is supported in version 1.8.6 and higher.
See also a more detailed description.
Include no You may include individual files or all files in a directory in the configuration file.
To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: /absolute/path/to/config/files/*.conf. Pattern matching is supported since Zabbix 2.4.0.
See special notes about limitations.
ListenIP no 0.0.0.0 List of comma-delimited IP addresses that the agent should listen on.
Multiple IP addresses are supported since Zabbix 1.8.3.
ListenPort no 1024-32767 10050 Agent will listen on this port for connections from the server.
LogFile yes, if LogType is set to file, otherwise
no
C:\zabbix_agentd.log Name of the agent log file.
LogFileSize no 0-1024 1 Maximum size of log file in MB.
0 - disable automatic log rotation.
Note: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew.
LogType no file Log output type:
file - write log to file specified by LogFile parameter,
system - write log Windows Event Log,
console - write log to standard output.
This parameter is supported since Zabbix 3.0.0.
LogRemoteCommands no 0 Enable logging of executed shell commands as warnings.
0 - disabled
1 - enabled
MaxLinesPerSecond no 1-1000 20 Maximum number of new lines the agent will send per second to Zabbix server
or proxy processing 'log', 'logrt' and 'eventlog' active checks.
The provided value will be overridden by the parameter 'maxlines',
provided in 'log', 'logrt' or 'eventlog' item keys.
Note: Zabbix will process 10 times more new lines than set in MaxLinesPerSecond to seek the required string in log items.
PerfCounter no Syntax: <parameter_name>,"<perf_counter_path>",<period>
Defines new parameter <parameter_name> which is an average value for system performance counter <perf_counter_path> for the specified time period <period> (in seconds).
For example, if you wish to receive average number of processor interrupts per second for last minute, you can define new parameter "interrupts" as following:
PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60
Please note double quotes around performance counter path.
The parameter name (interrupts) is to be used as the item key when creating an item.
Samples for calculating average value will be taken every second.
You may run "typeperf -qx" to get list of all performance counters available in Windows.
PerfCounterEn no Syntax: <parameter_name>,"<perf_counter_path>",<period>
Defines new parameter <parameter_name> which is an average value for system performance counter <perf_counter_path> for the specified time period <period> (in seconds).
Compared to PerfCounter, perfcounter paths must be in English.
Supported only on Windows Server 2008/Vista and above.
For example, if you wish to receive average number of processor interrupts per second for last minute, you can define new parameter "interrupts" as following:
PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60
Please note double quotes around performance counter path.
The parameter name (interrupts) is to be used as the item key when creating an item.
Samples for calculating average value will be taken every second.
You can find the list of English strings by viewing the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.
This parameter is supported since Zabbix 4.0.13.
RefreshActiveChecks no 60-3600 120 How often list of active checks is refreshed, in seconds.
Note that after failing to refresh active checks the next refresh will be attempted after 60 seconds.
Server yes, if StartAgents is not explicitly set to 0 List of comma delimited IP addresses, optionally in CIDR notation, or hostnames of Zabbix servers.
Incoming connections will be accepted only from the hosts listed here.
If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address.
'0.0.0.0/0' can be used to allow any IPv4 address.
Note, that "IPv4-compatible IPv6 addresses" (0000::/96 prefix) are supported but deprecated by RFC4291.
Example: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.domain
Spaces are allowed.
ServerActive no (*) IP:port (or hostname:port) of Zabbix server or Zabbix proxy for active checks.
Multiple comma-delimited addresses can be provided to use several independent Zabbix servers in parallel. Spaces are allowed.
If port is not specified, default port is used.
IPv6 addresses must be enclosed in square brackets if port for that host is specified.
If port is not specified, square brackets for IPv6 addresses are optional.
If this parameter is not specified, active checks are disabled.
SourceIP no Source IP address for:
- outgoing connections to Zabbix server or Zabbix proxy;
- making connections while executing some items (web.page.get, net.tcp.port, etc.)
StartAgents no 0-63 (*) 3 Number of pre-forked instances of zabbix_agentd that process passive checks.
If set to 0, disables passive checks and the agent will not listen on any TCP port.
The upper limit used to be 16 before version 1.8.5.
Timeout no 1-30 3 Spend no more than Timeout seconds on processing
TLSAccept yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no What incoming connections to accept. Used for a passive checks. Multiple values can be specified, separated by comma:
unencrypted - accept connections without encryption (default)
psk - accept connections with TLS and a pre-shared key (PSK)
cert - accept connections with TLS and a certificate
This parameter is supported since Zabbix 3.0.0.
TLSCAFile no Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components.
This parameter is supported since Zabbix 3.0.0.
TLSCertFile no Full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications with Zabbix components.
This parameter is supported since Zabbix 3.0.0.
TLSConnect yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no How the agent should connect to Zabbix server or proxy. Used for active checks. Only one value can be specified:
unencrypted - connect without encryption (default)
psk - connect using TLS and a pre-shared key (PSK)
cert - connect using TLS and a certificate
This parameter is supported since Zabbix 3.0.0.
TLSCRLFile no Full pathname of a file containing revoked certificates. This parameter is used for encrypted communications with Zabbix components.
This parameter is supported since Zabbix 3.0.0.
TLSKeyFile no Full pathname of a file containing the agent private key used for encrypted communications with Zabbix components.
This parameter is supported since Zabbix 3.0.0.
TLSPSKFile no Full pathname of a file containing the agent pre-shared key used for encrypted communications with Zabbix components.
This parameter is supported since Zabbix 3.0.0.
TLSPSKIdentity no Pre-shared key identity string, used for encrypted communications with Zabbix server.
This parameter is supported since Zabbix 3.0.0.
TLSServerCertIssuer no Allowed server (proxy) certificate issuer.
This parameter is supported since Zabbix 3.0.0.
TLSServerCertSubject no Allowed server (proxy) certificate subject.
This parameter is supported since Zabbix 3.0.0.
UnsafeUserParameters no 0-1 0 Allow all characters to be passed in arguments to user-defined parameters.
0 - do not allow
1 - allow
The following characters are not allowed:
\ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
Additionally, newline characters are not allowed.
UserParameter User-defined parameter to monitor. There can be several user-defined parameters.
Format: UserParameter=<key>,<shell command>
Note that shell command must not return empty string or EOL only.
Example: UserParameter=system.test,echo 1

(*) The number of active servers listed in ServerActive plus the number of pre-forked instances for passive checks specified in StartAgents must be less than 64.

See also

  1. Differences in the Zabbix agent configuration for active and passive checks starting from version 2.0.0.