2 Пользовательские макросы

Обзор

В дополнение к макросам поддерживающимся из коробки в Zabbix также для большей гибкости поддерживаются пользовательские макросы.

Пользовательские макросы можно можно определить на глобальном, уровне шаблона и уровне узла сети. Такие макросы имеют специальный синтаксис:

{$МАКРОС}

Пользовательские макросы можно использовать в:

именах элементов данных
в параметрах ключей элементов данных
именах и описаниях триггеров
в параметрах и константах выражений триггеров (смотрите примеры)
многих других местах (смотрите Макросы поддерживаемые по назначению)

В именах макросов допускаются следующие символы: A-Z , 0-9 , _ , .

Zabbix раскрывает макросы в соответствии со следующей очередностью:

макрос, назначенный узлу сети (проверяется в первую очередь)
макрос, назначенный на первый уровень шаблонов у узла сети (т.е. шаблоны присоединенные напрямую к узлу сети), которые отсортированы по ID шаблона
макрос, назначенный на второй уровень шаблонов у узла сети, которые отсортированы по ID шаблона
макрос назначенный на третий уровень шаблонов у узла сети, которые отсортированы по ID шаблона и так далее
глобальные макросы (проверяются в последнюю очередь)

Иными словами, если макрос не существует непосредственно у узла сети, тогда Zabbix попытается найти его в шаблонах, присоединенных к этому узлу сети, с учетом увеличивающейся глубины шаблонов. Если макрос все еще не найден, то будет использован макрос глобального уровня, если он существует конечно.

В случае, если Zabbix не удалось найти макрос, макрос не будет раскрыт.

Для добавления пользовательских макросов, перейдите в соответствующие разделы в веб-интерфейсе:

для глобальных макросов, посетите Администрирование → Общие → Макросы
для макросов на уровне узлов сети и шаблонов, откройте свойства узла сети или шаблона и найдите вкладку Макросы

Если пользовательский макрос используется в элементах данных или триггерах шаблона, то предлагается добавить этот макрос к шаблону, даже если он задан на глобальном уровне. Таким образом при экспорте шаблона в XML и импорте его в другую систему элементы данных и триггеры продолжат работать, как это и ожидалось.

Общие случаи использования глобальных макросов и макросов уровня узлов сети

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

Примеры

Пример 1

Использование макроса в ключе элемента данных "Состояние демона SSH":

net.tcp.service[ssh,{$SSH_PORT}]

Этот элемент данных можно присоединить к нескольким узлам сети, при условии, что значение {$SSH_PORT} указано на этих узлах сети.

Пример 2

Использование макроса уровня узла сети в триггере "Загрузка CPU слишком высокая":

{ca_001:system.cpu.load[,avg1].last()}>{$MAX_CPULOAD}

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

Если вы хотите использовать количество значений в качестве параметра функции (например, max(#3)), добавьте символ решетки # непосредственно в значение макроса, например вот так: SOME_PERIOD ⇒ #3

Пример 3

Использование двух макросов в триггере "Загрузка CPU слишком высокая":

{ca_001:system.cpu.load[,avg1].min({$CPULOAD_PERIOD})}>{$MAX_CPULOAD}

Заметьте, что макрос можно использовать в качестве параметра в функциях триггеров, в этом примере в функции min().

Пользовательские макросы будут раскрыты в триггерах, если макросы используются в параметрах или как константы. Они НЕ будут раскрыты, если используются как ссылка на функции, имена узлов сети, ключи элементов данных или операторы.

Контекст пользовательских макросов

В пользовательских макросах можно использовать опциональный контекст, позволяющий переопределять значение по умолчанию на значение с учётом конкретной ситуации.

Пользовательские макросы с контекстом имеют схожий синтаксис:

{$МАКРОС:контекст}

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

В контекстах макроса поддерживаются только макросы низкоуровневого обнаружения. Любые другие макросы игнорируются и обрабатываются как текстовые значения.

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

Контекст макроса необходимо заключать в " кавычки, если контекст содержит } символ или начинается с " символа. Кавычки внутри заключенном в кавычки контексте необходимо экранировать при помощи \ символа. Сам символ \ не экранируется, что означает, что невозможно задать заключенный в кавычки контекст оканчивающийся на \ символ - макрос {$MACRO:"a:\b\c\"} ошибочный
Пробелы в начале контекста игнорируются, пробелы в конце не игнорируются. Например, {$MACRO:A} тоже самое что и {$MACRO: A}, но не {$MACRO:A }.
Все пробелы до кавычек в начале и после кавычек игнорируются, но все пробелы внутри кавычек не игнорируются. Макросы {$MACRO:"A"}, {$MACRO: "A"}, {$MACRO:"A" } и {$MACRO: "A" } одинаковы, но макрос {$MACRO:"A"} и {$MACRO:" A "} не одинаковы.

Следующие макросы одинаковы, так как имеют один и тот же контекст: {$MACRO:A}, {$MACRO: A} и {$MACRO:"A"}. Такое поведение отлично от ключей элементов данных, где key[a], key[ a] и key["a"] одинаковы семантически, но различны для критерия уникальности.

Когда макросы с контекстами обрабатываются, Zabbix ищет макрос со своим контекстом вычисляется. Если макрос с этим контекстом не задан на узле сети или присоединенных шаблонах, и не задан как глобальный макрос с контекстом, тогда выполняется поиск макроса без контекста.

Смотрите пример использования контекста макроса в прототипе триггера о свободном месте на диске и примите во внимание пункт об ограничениях.

Documentation