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

Обзор

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

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

{$МАКРОС}

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

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

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

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

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

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

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

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

Настройка

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

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

Пользовательский макрос имеет следующие атрибуты:

Параметр	Описание
Макрос	Имя макроса. Имя должно быть заключено в фигурные скобки и начинаться с символа доллара. Пример: {$FRONTEND_URL}. В именах макросов допускаются следующие символы: A-Z (только в верхнем регистре) , 0-9 , _ , .
Значение	Значение макроса. Поддерживаются три типа значений: Текст (по умолчанию) - значение в виде простого текста Скрытый текст - значение маскируется звёздочками, что может быть полезным для защиты конфиденциальной информации, такой как пароли или общие ключи. Секрет Хранилища - значение содержит путь ссылки (в виде 'путь:ключ', например, “secret/zabbix:password”) к секрету Хранилища Обратите внимание, хотя значение секретного макроса скрыто от глаз, значение может быть раскрыто через использование в элементах данных. Например, во внешнем скрипте оператор 'echo', который ссылается на секретный макрос, можно использовать для раскрытия значения макроса в веб-интерфейсе, поскольку Zabbix сервер имеет доступ к реальному значению макроса. Для выбора типа значения нажмите на кнопку в конце поля ввода значения: иконка обозначает текстовый макрос; иконка обозначает скрытый текстовый макрос. При наведении курсора значение поля трансформируется в кнопку (Задать новое значение), которая позволяет ввести новое значение для макроса (чтобы выйти без сохранения нового значения, нажмите на стрелку назад ). иконка обозначает секретный макрос Хранилища. Максимальная длина значения пользовательского макроса составляет 2048 символов (255 символов в версиях до 5.2.0).
Описание	Текстовое поле, используемое для предоставления дополнительной информации о макросе.

Примеры

Пример 1

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

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

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

Пример 2

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

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

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

Пример 3

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

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

Обратите внимание, что макрос можно использовать как параметр триггерной функции, в данном примере в функции min().

Пример 4

Синхронизация условия недоступности агентов с интервалом обновления элемента данных:

• задайте макрос {$INTERVAL} и используйте его в интервале обновления элемента данных;
• используйте {$INTERVAL} как параметр в триггере на недоступность агента:

nodata(/ca_001/agent.ping,{$INTERVAL})=1

Пример 5

Централизованная настройка рабочего времени:

• создайте глобальный макрос {$WORKING_HOURS}, равный значению 1-5,09:00-18:00;
• используйте его в поле Рабочее время в разделе Администрирование → Общие → Веб-интерфейс;
• используйте его в поле Когда активно в Администрирование → Пользователь → Оповещения;
• используйте его для настройки более частого опроса элементов данных в течение рабочего времени:

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

Пример 6

Используйте макрос прототипа узлов сети для настройки элементов данных у обнаруженных узлов сети:

• на уровне прототипа узлов сети задайте пользовательский макрос {$SNMPVALUE} с значением в виде макроса низкоуровневого обнаружения {#SNMPVALUE}:

• назначьте шаблон Generic SNMPv2 на прототип узлов сети;
• используйте {$SNMPVALUE} в поле SNMP OID элементов данных шаблона Generic SNMPv2.

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

Смотрите пользовательские макросы с контекстом.