Этот раздел подробно описывает пассивные и активные проверки, которые выполняются Zabbix агентом.
Для взаимодействия с агентами Zabbix использует коммуникационный протокол на основе JSON.
Протоколы Zabbix агента и Zabbix агента 2 были унифицированы, начиная с версии Zabbix 7.0. Отличие между запросами/ответами Zabbix агента и Zabbix агента 2 выражается значением тега «variant».
Пассивная проверка — это простой запрос данных. Zabbix сервер или прокси запрашивает какие-либо данные (например, загрузку CPU), а Zabbix агент отправляет результат обратно на сервер.
Пассивные проверки выполняются асинхронно — не требуется получения ответа на один запрос до запуска других проверок. DNS резолвинг также выполняется асинхронно.
Максимальное число одновременных асинхронных проверок составляет 1000 (определяется параметром MaxConcurrentChecksPerPoller).
Количество асинхронных поллеров агента определяется параметром StartAgentPollers.
Запрос сервера
Для получения более подробных сведений об определении длины заголовка и данных, пожалуйста, обратитесь к подробностям протокола.
Ответ агента
Например, для поддерживаемых элементов данных:
Для неподдерживаемых элементов данных:
Чтобы обеспечить воможность работы Zabbix-сервера или прокси с агентами версий до 7.0, которые имеют простой текстовый протокол, реализовано переключение на старый протокол.
Пассивные проверки выполняются по протоколу JSON (7.0 и выше) после перезапуска или при изменении конфигурации интерфейса. Если в ответ не получен корректный JSON (агент отправил «ZBX_NOTSUPPORTED»), Zabbix закэширует интерфейс как старый протокол и повторит проверку, пересылая только ключ элемента данных.
Обратите внимание, что каждый час сервер/прокси Zabbix снова будет пытаться работать с новым протоколом со всеми интерфейсами, при необходимости переключаясь на старый протокол.
Активные проверки требуют более сложной обработки. Агент сначала должен получить с сервера/прокси список элементов данных и/или удалённых команд для независимой обработки.
Сервера/прокси для получения активных проверок перечислены в параметре «ServerActive» файла конфигурации агента. Частота запросов данных проверок настраивается параметром «RefreshActiveChecks» в этом же файле конфигурации. Однако, если обновление активных проверок завершится с ошибкой, запрос повторится через (жёстко заданные в коде) 60 секунд.
Начиная с версии Zabbix 6.4, агент (в активном режиме) больше не получает от сервера/прокси полную копию конфигурации раз в две минуты (по умолчанию). Вместо этого, чтобы уменьшить сетевой трафик и использование ресурсов, каждые 5 секунд (по умолчанию) выполняется инкрементная синхронизация конфигурации, после чего сервер/прокси-сервер предоставляет полную копию конфигурации только, если агент ещё не получил её либо что-то изменилось в конфигурации узла сети, глобальных макросах или глобальных регулярных выражениях.
Затем агент периодически отправляет новые значения на сервер(ы). Если агент получил какие-либо удалённые команды для выполнения, также будет отправлен результат выполнения. Обратите внимание, что удалённое выполнение команд на активном агенте поддерживается, начиная с версии Zabbix агента 7.0.
Если агент находится за брандмауэром, вы можете рассмотреть возможность использования исключительно Активных проверок, т.к. в этом случае вам не понадобится менять настройки брандмауэра для разрешения начальных входящих соединений.
Запрос агента
Запрос на активные проверки используется для получения списка активных проверок, обрабатываемых агентом. Этот запрос отсылается агентом после старта и затем с интервалом RefreshActiveChecks.
{
"request": "active checks",
"host": "Zabbix server",
"host_metadata": "mysql,nginx",
"hostinterface": "zabbix.server.lan",
"ip": "159.168.1.1",
"port": 12050,
"version": "7.0.0",
"variant": 2,
"config_revision": 1,
"session": "e3dcbd9ace2c9694e1d7bbd030eeef6e"
}
Поле | Тип | Обязательный | Значение |
---|---|---|---|
request | строка | да | active checks |
host | строка | да | Имя узла сети. |
host_metadata | строка | нет | Значение параметра конфигурации HostMetadata или метрики HostMetadataItem. |
hostinterface | строка | нет | Значение параметра конфигурации HostInterface или метрики HostInterfaceItem. |
ip | строка | нет | Первый IP параметра конфигурации ListenIP, если задан. |
port | число | нет | Значение параметра конфигурации ListenPort, если задано и не является портом, прослушиваемым агентом по умолчанию. |
version | строка | да | Номер версии агента. |
variant | число | да | Вариант агента (1 — Zabbix агент, 2 — Zabbix агент 2). |
config_revision | число | нет | Идентификатор конфигурации для инкрементной синхронизации конфигурации. |
session | строка | нет | Идентификатор сессии для инкрементной синхронизации конфигурации |
Ответ сервера
Ответ активных проверок посылается сервером обратно агенту после обработки запроса на активные проверки.
{
"response": "success",
"config_revision": 2,
"data": [
{
"key": "system.uptime",
"itemid": 1234,
"delay": "10s",
"lastlogsize": 0,
"mtime": 0
},
{
"key": "agent.version",
"itemid": 5678,
"delay": "10m",
"lastlogsize": 0,
"mtime": 0,
"timeout": "30s"
}
],
"commands": [
{
"command": "df -h --output=source,size / | awk 'NR>1 {print $2}'",
"id": 1324,
"wait": 1
}
]
}
Поле | Тип | Обязательный | Значение | |
---|---|---|---|---|
response | строка | да | success | failed |
|
info | строка | нет | Сообщение об ошибке в случае сбоя. | |
data | массив объектов | нет | Элементы данных для активных проверок. Опущено, если конфигурация узла сети не изменилась. | |
key | строка | нет | Ключ элемента данных с раскрытыми макросами. | |
itemid | число | нет | Идентификатор элемента данных. | |
delay | строка | нет | Интервал обновления элемента данных. Гибкие интервалы и интервалы по расписанию поддерживаются как Zabbix агентом, так и Zabbix агентом 2, начиная с версии Zabbix 7.0. |
|
lastlogsize | число | нет | Последний размер файла журнала (lastlogsize) элемента данных. | |
mtime | число | нет | Отметка времени последнего обновления (mtime) элемента данных. | |
timeout | строка | нет | Время ожидания элемента данных. | |
refresh_unsupported | число | нет | Интервал обновления неподдерживаемого элемента данных. | |
regexp | массив объектов | нет | Глобальные регулярные выражения. | |
name | строка | нет | Имя глобального регулярного выражения. | |
expression | строка | нет | Глобальное регулярное выражение. | |
expression_type | число | нет | Тип глобального регулярного выражения. | |
exp_delimiter | строка | нет | Разделитель глобального регулярного выражения. | |
case_sensitive | число | нет | Признак чувствительности к регистру глобального регулярного выражения. | |
commands | массив объектов | нет | Удалённые команды для выполнения. Присутствует, если выполнение удалённой команды было инициировано операцией действия или запуском скрипта вручную. Обратите внимание, что удалённое выполнение команд на активном агенте поддерживается, начиная с версии Zabbix агента 7.0. Более старые активные агенты будут игнорировать любые удалённые команды, включённые в ответ активных проверок сервера. | |
command | строка | нет | Удалённая команда. | |
id | число | нет | Идентификатор удалённой команды. | |
wait | число | нет | Режим выполнения удалённой команды ("0" (nowait, без ожидания) для команд из операций действий; "1" (wait, с ожиданием) для команд из запуска скрипта вручную). | |
config_revision | число | нет | Идентификатор конфигурации для инкрементной синхронизации конфигурации. Будет отсутствовать, если конфигурация узла сети не меняется. При изменении конфигурации узла сети возрастает. |
Ответ сервера должен быть успешным.
Например:
Обратите внимание, что при использовании активных проверок (чувствительные) данные конфигурации могут стать доступными лицам, имеющим доступ к порту траппера Zabbix сервера. Это возможно, так как любой может представиться активным агентом и запросить данные конфигурации элементов данных; аутентификация не производится, если только вы не используете опции шифрования.
Агент отправляет
Запрос агента с данными содержит собранные значения элементов данных и значения для выполненных удалённых команд (если таковые имеются).
{
"request": "agent data",
"data": [
{
"id": 1,
"itemid": 5678,
"value": "7.0.0",
"clock": 1712830783,
"ns": 76808644
},
{
"id": 2,
"itemid": 1234,
"value": "69672",
"clock": 1712830783,
"ns": 77053975
}
],
"commands": [
{
"id": 1324,
"value": "16G"
}
],
"session": "1234456akdsjhfoui",
"host": "Zabbix server",
"version": "7.0.0",
"variant": 2
}
Поле | Тип | Обязательный | Значение | |
---|---|---|---|---|
request | строка | да | agent data |
|
data | массив объектов | да | Значения элементов данных. | |
id | число | да | Идентификатор значения (возрастающий счётчик, используемый для проверки дубликатов значений в случае сетевых проблем). | |
itemid | строка | да | Идентификатор элемента данных. | |
value | строка | нет | Значение элемента данных. | |
lastlogsize | число | нет | Последний размер журнала (lastlogsize) элемента данных. | |
mtime | число | нет | Отметка времени последнего обновления (mtime) элемента данных. | |
state | число | нет | Состояние элемента данных. | |
source | строка | нет | Источник (source) значения журнала событий. | |
eventid | число | нет | Идентификатор (eventid) значения журнала событий. | |
severity | число | нет | Важность (severity) значения журнала событий. | |
timestamp | число | нет | Отметка времени (timestamp) значения журнала событий. | |
clock | число | да | Отметка времени значения (секунд с начала эпохи). | |
ns | число | да | Наносекунды отметки времени значения. | |
commands | массив объектов | нет | Результат выполнения удалённых команд. Обратите внимание, что выполнение удалённых команд на активном агенте поддерживается, начиная с версии Zabbix агента 7.0. Более старые активные агенты будут игнорировать любые удалённые команды, включённые в ответ активных проверок сервера. | |
id | число | нет | Идентификатор удалённой команды. | |
value | строка | нет | Результат выполнения удалённой команды при успешном выполнении. | |
error | строка | нет | Сообщение об ошибке выполнения удалённой команды при неуспешном выполнении. | |
session | строка | да | Уникальный идентификатор сессии, генерируемый каждый раз при старте агента. | |
host | строка | да | Имя узла сети. | |
version | строка | да | номер версии агента. | |
variant | число | да | Вариант агента (1 — Zabbix агент, 2 — Zabbix агент 2). |
Виртуальный ID назначается каждому значению. Значением ID является простой счётчик с инкрементом, уникальный в пределах одной сессии передачи данных (идентифицируемой при помощи токена сессии). Этот ID используется, чтобы отбрасывать дубликаты значений, которые могут быть отправлены в средах с плохой связью.
Ответ сервера
Ответ на данные агента отсылается сервером назад агенту после обработки запроса агента с данными.
Поле | Тип | Обязательный | Значение |
---|---|---|---|
response | строка | да | success | failed |
info | строка | да | Результаты обработки элементов данных. |
Если отправка некоторых значений завершилась неудачей на сервере (например, по причине того, что узел сети или элемент данных был деактивирован или удалён), агент не будет повторять отправку этих элементов данных
Например:
Обратите внимание на то, как в примере выше указывается неподдерживаемое состояние для vfs.fs.size[/nono] при помощи значения "state", равного 1, и сообщения об ошибке в свойстве "value".
Сообщение об ошибке будет обрезано до 2048 символов на стороне сервера.
Сообщение heartbeat («Я жив») отправляется активным агентом Zabbix серверу/прокси каждые HeartbeatFrequency секунд (настраивается в файле конфигурации Zabbix агента/ агента 2).
Используется для контроля доступности активных проверок
{
"request": "active check heartbeat",
"host": "Zabbix server",
"heartbeat_freq": 60,
"version": "7.0.0",
"variant": 2
}
Поле | Тип | Обязательный | Значение |
---|---|---|---|
request | строка | да | active check heartbeat |
host | строка | да | Имя узла сети. |
heartbeat_freq | число | да | Частота сигналов «Я жив» (параметр конфигурации HeartbeatFrequency). |
version | строка | да | Номер версии агента. |
variant | число | да | Вариант агента (1 — Zabbix агент, 2 — Zabbix агент 2). |
Zabbix воспринимает до 16 МВ XML данных, закодированных в Base64, но одиночное декодированное значение не должно быть длиннее 64 КБ, в противном случае значение будет обрезано до 64 КБ в процессе декодирования.