6. Zabbix агент 2 (Windows)

Обзор

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

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

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

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

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

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

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

Alias

Задаёт алиас для ключа элемента данных. Его можно использовать для замены длинных и сложных ключей элементов данных на более короткие и простые.
Можно добавлять несколько параметров 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 — включено

EnableProfiler

Включает периодическое профилирование Go при запуске агента. Профилирование также можно включить или отключить во время выполнения с помощью параметра -R. Пока periodic_prof_execute собирает профили, все команды профилировщика во время выполнения отклоняются с сообщением о занятости. Этот параметр поддерживается начиная с Zabbix 7.0.31.

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

ForceActiveChecksOnStart

Выполнить активные проверки сразу после перезапуска для первой полученной конфигурации. Также доступно как параметр конфигурации плагина, например: Plugins.Uptime.System.ForceActiveChecksOnStart=1

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

HeartbeatFrequency

Частота контрольных сообщений (heartbeat) в секундах. Используется для контроля доступности активных проверок.
0 — контрольные сообщения отключены.

По умолчанию: 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 позволяет различать узлы сети не только по имени хоста.

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

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

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

Hostname

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

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

HostnameItem

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

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

Include

Укажите каталог или отдельные файлы, которые нужно включить в файл конфигурации (по умолчанию расположен в C:\Program Files\Zabbix Agent 2, если Zabbix агент установлен с помощью MSI-пакетов для Windows; расположен в папке, указанной при установке, если Zabbix агент установлен как zip-архив).

Общие правила для параметра Include:

• Путь может быть относительным относительно положения файла zabbix_agent2.conf (например, Include=.\zabbix_agent2.d\plugins.d\*.conf).
• В одном файле конфигурации можно указать несколько параметров Include.
• Zabbix обрабатывает параметр Include по мере его чтения, поэтому рекомендуется размещать его в конце файла конфигурации.

Правила для включаемых файлов:

• Каждый файл должен быть доступен для чтения.
• Каждый файл должен иметь корректный синтаксис. В противном случае компонент не запустится.

Правила для включения каталогов или шаблонов файлов:

• Не следует предполагать какой-либо порядок включения (например, файлы не включаются в алфавитном порядке).
• Не определяйте один и тот же параметр более чем в одном включаемом файле (например, чтобы переопределить общий параметр более конкретным), так как невозможно предсказать, какое значение будет использовано.
• Обратите внимание на резервные копии, которые некоторые текстовые редакторы создают автоматически (например, при редактировании include/my_specific.conf может быть создан include/my_specific.conf.BAK), поскольку будут включены оба файла.

Чтобы включать только нужные файлы из каталога, используйте подстановочный знак (*) для сопоставления шаблона.

Пример:

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 — вывод журнала в стандартный вывод.

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

PersistentBufferFile

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

PersistentBufferPeriod

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

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

Plugins.<PluginName>.System.Capacity

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

Значение по умолчанию: 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

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

По умолчанию: \\.\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) используется в качестве ключа элемента данных при создании элемента данных. Выборки для расчета среднего значения будут выполняться каждую секунду.
Чтобы получить список всех доступных в Windows счетчиков производительности, можно выполнить команду typeperf -qx.

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.

ProfilerDir

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

Значение по умолчанию: c:\zabbix_pprof

ProfilerMaxFilesPerProfile

Максимальное количество файлов, сохраняемых для каждого типа профиля. Ограничение применяется к завершённым файлам после каждого дампа профиля. Активный профиль ЦП собирается в скрытый временный файл и не учитывается при расчёте ограничения. Файлы, созданные с помощью periodic_prof_execute, также подпадают под это ограничение. Этот параметр поддерживается начиная с Zabbix 7.0.31.

Значение по умолчанию: 10
Диапазон: 1-100

ProfilerInterval

Интервал записи данных профилирования в секундах. Этот параметр поддерживается начиная с Zabbix 7.0.31.

Значение по умолчанию: 3600
Диапазон: 1–86400

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-имя и необязательный порт, разделённые двоеточием. Если порт не указан, используется порт по умолчанию.
Адреса IPv6 должны быть заключены в квадратные скобки, если для этого узла сети указан порт. Если порт не указан, квадратные скобки для адресов IPv6 необязательны.

Конфигурация кластера — это один или более адресов серверов либо членов группы прокси, разделённых точкой с запятой.

Можно указать несколько серверов/кластеров/прокси Zabbix, разделяя их запятой.

От каждого сервера/кластера Zabbix должно быть указано не более одного Zabbix прокси, если только не используются группы прокси.

Если указан Zabbix прокси, то сервер/кластер Zabbix для этого прокси не должны быть указаны.

Несколько адресов через запятую можно указать для использования нескольких независимых серверов Zabbix параллельно. Пробелы разрешены.

Пример для прокси 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 серверу или прокси;
• создания подключений при выполнении некоторых элементов данных (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.

TLSCipherAll13

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

Пример:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

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

TLSCipherCert13

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

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

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

TLSCipherPSK13

Строка шифров OpenSSL (TLS 1.3). Переопределяет критерии выбора алгоритмов шифрования по умолчанию для шифрования на основе общего ключа (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,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

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

Пример:

UserParameterDir=C:\opt\myscripts