6 Zabbix агент 2 (Windows)

Обзор

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

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

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

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

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

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

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

Псевдоним

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

Пример 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] и т. д.

AllowKey

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

BufferSend

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

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

BufferSize

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

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

ControlSocket

Управляющий сокет, используемый для отправки команд времени выполнения с опцией '-R'.

По умолчанию: \\.\pipe\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 — включено

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-именами, также будут отклонены и отмечены как недопустимые.

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

Hostname

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

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

HostnameItem

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

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

Include

Вы можете включать отдельные файлы или все файлы в каталоге в файл конфигурации (по умолчанию он расположен в C:\Program Files\Zabbix Agent 2, если агент Zabbix установлен с помощью пакетов установщика Windows MSI; расположен в папке, указанной во время установки, если агент Zabbix установлен как zip-архив). Все включаемые файлы должны иметь корректный синтаксис, в противном случае агент не запустится. Путь может быть относительным по отношению к расположению файла zabbix_agent2.conf (например, Include=.\zabbix_agent2.d\plugins.d\*.conf).
Чтобы включать только подходящие файлы в указанном каталоге, для сопоставления с шаблоном поддерживается символ подстановки звёздочка.
См. специальные примечания об ограничениях.

Пример:

Include=C:\Program Files\Zabbix Agent2\zabbix_agent2.d\*.conf

ListenIP

Список IP-адресов, разделённых запятыми, которые агент должен прослушивать. Первый IP-адрес отправляется на сервер Zabbix при подключении к нему для получения списка активных проверок.

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

ListenPort

Агент будет прослушивать этот порт на предмет соединений с сервером.

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

LogFile

Имя файла журнала агента.

По умолчанию: c:\zabbix_agent2.log
Обязательно: Да, если LogType установлен в file; в противном случае нет

LogFileSize

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

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

LogType

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

По умолчанию: файл

PersistentBufferFile

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

PersistentBufferPeriod

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

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

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

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

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

Plugins.Log.MaxLinesPerSecond

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

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

Plugins.SystemRun.LogRemoteCommands

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

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

PluginSocket

Путь к сокету UNIX для связи с загружаемым плагином.

По умолчанию: \\.\pipe\agent.plugin.sock

PluginTimeout

Таймаут соединений с загружаемыми плагинами, в секундах.

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

PerfCounter

Определяет новый параметр <parameter_name>, который является средним значением системного счётчика производительности <perf_counter_path> за указанный период времени <period> (в секундах).
Синтаксис: <parameter_name>,"<perf_counter_path>",<period>

Например, если вы хотите получать среднее количество прерываний процессора в секунду за последнюю минуту, вы можете определить новый параметр "interrupts" следующим образом:

PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60

Обратите внимание на двойные кавычки вокруг пути к счётчику производительности. Имя параметра (interrupts) должно использоваться как ключ элемента данных при создании элемента данных. Выборки для вычисления среднего значения будут выполняться каждую секунду.
Вы можете выполнить команду "typeperf -qx", чтобы получить список всех счётчиков производительности, доступных в Windows.

PerfCounterEn

Определяет новый параметр <parameter_name>, который является средним значением системного счётчика производительности <perf_counter_path> за указанный период времени <period> (в секундах). По сравнению с PerfCounter, пути perfcounter должны быть на английском языке. Поддерживается только в Windows Server 2008/Vista и более поздних версиях.
Синтаксис: <parameter_name>,"<perf_counter_path>",<period>

Например, если вы хотите получать среднее количество прерываний процессора в секунду за последнюю минуту, вы можете определить новый параметр "interrupts" следующим образом:

PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60

Обратите внимание на двойные кавычки вокруг пути к счётчику производительности. Имя параметра (interrupts) следует использовать как ключ элемента данных при создании элемента данных. Выборки для вычисления среднего значения будут выполняться каждую секунду.
Список английских строк можно найти, просмотрев следующий раздел реестра: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.

RefreshActiveChecks

Как часто обновляется список активных проверок, в секундах. Обратите внимание, что после неудачной попытки обновить активные проверки следующая попытка обновления будет выполнена через 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-адрес. Пробелы допускаются. Если этот параметр не указан, пассивные проверки отключаются, и агент не будет прослушивать ни один 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 для этого прокси указывать не следует.
Можно указать несколько адресов, разделённых запятыми, чтобы использовать несколько независимых серверов 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 и т. д.).

StatusPort

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

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

Timeout

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

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

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

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

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

TLSAccept

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

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

TLSCAFile

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

TLSCertFile

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

TLSCipherAll13

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

Пример:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherCert13

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

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

TLSCipherPSK13

Строка шифров OpenSSL (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

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

UnsafeUserParameters

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

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

UserParameter

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

Пример:

UserParameter=system.test,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

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

Пример:

UserParameterDir=C:\opt\myscripts