Шаблоны уведомлений используются в уведомлениях о создании алертов.
Параметры шаблонов уведомлений
Параметр |
Описание |
---|---|
Название |
Обязательный параметр. Уникальное имя ресурса. Должно содержать от 1 до 128 символов в кодировке Unicode. |
Тенант |
Обязательный параметр. Название тенанта, которому принадлежит ресурс. |
Тема |
Тема электронного письма с уведомлением о создании алерта. В теме письма можно обращаться к полям алерта. Пример: |
Шаблон |
Обязательный параметр. Тело электронного письма с уведомлением о создании алерта. Шаблон поддерживает синтаксис, с помощью которого уведомление можно наполнить данными из алерта. Подробнее про синтаксис вы можете прочитать в официальной документации языка Go. Для удобства можно открыть текст письма в отдельном окне, нажав на значок . При этом открывается окно Шаблон, в котором можно править текст письма с уведомлением. Сохранить изменения и закрыть окно можно с помощью кнопки Сохранить. |
Предустановленные шаблоны уведомлений
В поставку KUMA включены перечисленные в таблице ниже шаблоны уведомлений.
Предустановленные шаблоны уведомлений
Название шаблона |
Описание |
[OOTB] New alert in KUMA |
Базовый шаблон уведомлений. |
Функции в шаблонах уведомлений
В шаблонах доступны функции, перечисленные в таблице ниже.
Функции в шаблонах
Параметр |
Описание |
---|---|
|
Принимает первым параметром время в миллисекундах (unix time), вторым параметром можно передать формат времени по стандартам RFC. Часовой пояс изменить нельзя. Пример вызова: Результат вызова: 18 Nov 2022 13:46 Примеры форматов дат, поддерживаемые функцией:
|
|
Функция вызывается внутри функции range для ограничения списка данных. Обрабатывает списки которые не имеют ключей, принимает любой список данных первым параметром и обрезает список по второму значению. Например, в функцию можно передавать поля алерта Пример вызова:
|
|
Формирует ссылку на алерт с URL, указанным в настройках подключения к SMTP-серверу в качестве псевдонима сервера Ядра KUMA или с реальным URL сервиса Ядра KUMA, если псевдоним не задан. Пример вызова:
|
|
Принимает вид ссылки, доступной для перехода. Пример вызова:
|
Синтаксис шаблона уведомления
В шаблоне можно обращаться к полям алерта, содержащим строку или число:
|
В письме будет отображаться название алерта, то есть содержимое поля CorrelationRuleName
.
Некоторые поля алерта содержат массивы данных. Например, это поля алерта с относящимися к нему событиями, активами, учетными записями. К таким вложенным объектам можно обращаться с помощью функции range, которая последовательно обращается к полям 50 первых вложенных объектов. При обращении с помощью функции range к полю, в котором нет массива данных, возвращается ошибка. Пример:
|
В письме будут отображаться значения полей DeviceHostName
и CreatedAt
из 50 связанных с алертом активов:
|
С помощью параметра limit можно ограничить количество объектов, возвращаемых функцией range:
|
В письме будут отображаться значения полей DisplayName
и CreatedAt
из 5 связанных с алертом активов, слова "Устройства" и "Дата создания" выделены HTML-тегами <strong>:
|
Вложенные объекты могут иметь свои вложенные объекты. К ним можно обратиться с помощью вложенных функций range:
|
В письме будет отображаться по десять идентификаторов сервисов (поле ServiceID
) из базовых событий, относящихся к пяти корреляционным событиям алерта. Всего 50 строк. Обратите внимание, что обращение к событиям происходит через вложенную структуру EventWrapper, которая находится в алерте в поле Events. События доступны в поле Event этой структуры, что отражено в примере выше. Таким образом, если поле A содержит вложенную структуру [B] и в структуре [B] есть поле C, которое является строкой или числом, то чтобы обратиться к полю C необходимо указать путь {{ A.C }}.
Некоторые поля объектов содержат вложенные словари в формате "ключ - значение" (например, поле событий Extra
). К ним можно обратиться с помощью функции range с переданными ей переменными: range $placeholder1, $placeholder2 := .FieldName
. Значения переменных затем можно вызывать, указывая из названия. Пример:
|
В письме через HTML-тег <br> будут отображаться пары "ключ - значение" из полей Extra
базовых событий, принадлежащих корреляционным событиям. Вызываются данные из пяти базовых событий из каждого из трех корреляционных событий.
В шаблонах уведомлений можно использовать HTML-теги, выстраивая их в сложные структуры. Ниже приводится пример таблицы для полей корреляционного события:
|
С помощью функции link_alert в письмо с уведомлением можно вставить HTML-ссылку на алерт:
|
В письме будет отображаться ссылка на окно алерта.
Ниже приведен пример, как можно из связанных с алертом данных извлечь сведения о наивысшей категории активов и поместить ее в уведомления:
|