14 Плагины

Плагины дают возможность расширить функционал Zabbix. Они написаны на языке Go и поддерживаются только для Zabbix агента 2. Они предоставляют альтернативу загружаемые модули (пишутся на C) и другим методам расширения функциональности Zabbix, таким как пользовательские параметры (метрики агента), внешие проверки (мониторинг без агента) и элементу данных Zabbix агента system.run []. Следующие функции относятся к агенту 2 и его плагинам:

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

Готовые плагины

Все метрики, поддерживаемые для Zabbix агента 2, собираются с помощью плагинов. Zabbix предоставляет ряд готовых плагинов для Zabbix агента 2:

Настройка плагинов

Общие принципы настройки и рекомендации описаны в этом разделе.

Для конкретных примеров конфигурации плагина смотрите также:

• Memcached
• MySQL
• Redis

Все настройки плагинов задаются с использованием параметра Plugins.* файла конфигурации Zabbix агента 2 . В отличие от других параметров агента, это не тип ключа / значения параметра. Это отдельный раздел, где могут быть описаны конкретные параметры плагина. Каждый параметр должен иметь следующую структуру:

Plugins.<PluginName>.<Parameter>=<Value>

Имена параметров должны соответствовать следующим требованиям:

• рекомендуется начинать названия ваших плагинов с заглавной буквы;
• параметр должен начинаться с заглавной буквы;
• специальные символы не разрешены;
• количество вложенных уровней нелимитировано;
• количество параметров не ограничено.

Именованные сессии

Именованные сессии представляют дополнительный уровень параметров плагина и могут использоваться для определения отдельных наборов параметров аутентификации для каждого отслеживаемого объекта. Каждый параметр именованной сессии должен иметь следующую структуру:

Plugins.<PluginName>.<SessionName>.<Parameter>=<Value>

Название именованной сессии может использоваться в качестве параметра connString ключа элемента данных вместо указания URI, имени пользователя и пароля отдельно.

Обратите внимание, что:

• при предоставлении connString (названия сессии) в параметрах ключа, параметры ключа для имени пользователя и пароля должны быть пустыми;
• передача встроенных в URI учетных данных не поддерживается, вместо этого рекомендуется использовать именованные сессии;
• в именованных сессиях поддерживаются только следующие параметры: Plugins.<PluginName>.<SessionName>.Uri, Plugins.<PluginName>.<SessionName>.User, Plugins.<PluginName>.<SessionName>.Password.
• если для указанной сессии не указан параметр аутентификации, будет использоваться значение по умолчанию.

Пример: Мониторинг двух объектов “MySQL1” и “MySQL2” может быть настроен следующим образом:

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
       Plugins.Mysql.Sessions.MySQL1.User=<UsernameForMySQL1>
       Plugins.Mysql.Sessions.MySQL1.Password=<PasswordForMySQL1>    
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://127.0.0.1:3307   
       Plugins.Mysql.Sessions.MySQL2.User=<UsernameForMySQL2>
       Plugins.Mysql.Sessions.MySQL2.Password=<PasswordForMySQL2>

Теперь эти имена можно использовать как connStrings в ключах вместо URI, например:

mysql.ping[MySQL1]
       mysql.ping[MySQL2]

Соединения

Некоторые плагины поддерживают сбор метрик из нескольких объектов одновременно. Можно отслеживать как локальные, так и удаленные объекты. Поддерживаются TCP и Unix-сокет соединения.

Рекомендуется настроить плагины так, чтобы они поддерживали соединения с объектами в открытом состоянии. Преимущества - снижение перегрузок в сети, сокращение задержек и использование меньшего объема ЦП и памяти из-за меньшего количества соединений. Клиентская библиотека позаботится об этом.

Написание плагинов

Плагин - Go пакет, который определяет структуру и реализует один или несколько интерфейсов плагина (Exporter, Collector, Configurator, Runner, Watcher):

• plugin.Exporter

Exporter - простейший интерфейс, который выполняет опрос и возвращает значение (значения), ничего, ошибку. Он принимает предварительно обработанные ключ элемента данных, параметры и контекст. Интерфейс Exporter является единственным интерфейсом, к которому можно получить доступ на конкурентной основе. Доступ ко всем остальным интерфейсам плагина эксклюзивный и нельзя вызвать никакой метод, когда плагин уже выполняет какую-нибудь задачу. Также имеется ограничение в 100 максимальных параллельных вызовов Export() на каждый плагин, это значение можно уменьшить, по мере необходимости, каждому плагину отдельно.

• plugin.Collector

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

• plugin.Configurator

Конфигуратор используется для предоставления плагину его параметров из файла конфигурации агента 2 .

• plugin.Runner

Интерфейс Runner предоставляет средства для выполнения некоторой инициализации, когда плагин запущен (активирован), и деинициализации, когда плагин остановлен (деактивирован). Например, плагин может запускать/останавливать некоторые фоновые процедуры, реализуя интерфейс Runner.

• plugin.Watcher

Watcher позволяет плагину самостоятельно запрашивать метрики, без использования внутреннего планировщика агента, например в плагинах, использующих трапы.

Плагины по умолчанию неактивны и активируются только при мониторинге метрик, предоставляемых плагином.

Плагины расположены в дереве каталогов плагинов, сгруппированные по значению, например plugins/system/uptime/uptime.go.

Этапы реализации

Плагин должен импортировать пакет zabbix.com/pkg/plugin.

import "zabbix.com/pkg/plugin"

Плагин должен определить структуру и внедрить структуру «plugin.Base».

type Plugin struct {
           plugin.Base
       }
       var impl Plugin

Плагин должен реализовывать один или несколько интерфейсов плагинов.

func (p *Plugin) Export(key string, params []string, ctx plugin.ContextProvider) (result interface{}, err error) {
           if len(params) > 0 {
               p.Debugf("received %d parameters while expected none", len(params))
               return nil, errors.New("Too many parameters")
           }
           return time.Now().Format(time.RFC3339)
       }

Плагин должен зарегистрироваться во время инициализации.

func init() {
           plugin.RegisterMetrics(&impl, "Time", "system.time", "Returns time string in RFC 3999 format.")
       }

Где параметры RegisterMetrics следующие:

• Указатель на реализацию плагина
• Имя плагина (в формате UpperCamelCase - без пробелов, каждое слово с заглавной буквы)
• Имя метрики #1 (ключ элемента данных)
• Описание метрики #1 (начиная с заглавной буквы и заканчивая точкой)
• Имя метрики #2 (ключ элемента данных) (не обязательно)
• Описание метрики #2 (начиная с заглавной буквы и заканчивая точкой) (не обязательно)
• ...

Если необходимо делать записи в журнал, плагин должен использовать функциональность журнаирования, предоставляемую plugin.Base (см. Пример выше). По сути, это оболочка для стандартного ведения журнала, но к сообщениям журнала добавляется префикс [<имя плагина>].