Документация Grafana Документация GlaberGraph Оповещения Настройка уведомлений Шаблонизация уведомлений Manage templates

Управление шаблонами уведомлений

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

По умолчанию Grafana предоставляет шаблон для заголовка уведомления ({{define "default.title"}}) и шаблон для уведомительного сообщения ({{define "default.message"}}). Оба шаблона по умолчанию отображают общие сведения об оповещении.

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

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

Выбор шаблона уведомления для точки контакта

Чтобы добавить существующий шаблон уведомления в вашу точку контакта, выполните следующие шаги.

1. Нажмите на существующую точку контакта или создайте новую.

2. В Optional settings нажмите любое поле, содержащее шаблоны.

   Например, если вы создаёте интеграцию точки контакта email, нажмите Message или Subject.

3. Нажмите Edit. Откроется диалоговое окно, где можно выбрать шаблоны уведомлений.

4. Нажмите Select notification template или Enter custom message, чтобы настроить шаблон или сообщение

   • Вы можете выбрать существующий шаблон уведомления и посмотреть его предпросмотр с использованием полезной нагрузки по умолчанию.
   • Вы также можете скопировать шаблон уведомления и использовать его на вкладке Enter custom message.

5. Нажмите Save contact point.

Вы можете создавать пользовательские шаблоны уведомлений на вкладке Enter custom message. Для переиспользуемых и единообразных уведомлений лучшей практикой является создание пользовательских шаблонов уведомлений, как описано в следующем разделе.

Создание шаблона уведомления и группы шаблонов уведомлений

Создавайте шаблоны уведомлений, чтобы настраивать уведомительные сообщения и переиспользовать их в точках контакта.

В Grafana пользовательские шаблоны уведомлений ({{define "<NAME>"}}) создаются внутри группы шаблонов уведомлений, что позволяет тестировать и реализовывать несколько шаблонов вместе.

Имя вашего шаблона уведомления ({{define "<NAME>"}}) должно быть уникальным. Вы не можете иметь два шаблона с одинаковым именем в одной группе шаблонов уведомлений или в разных группах шаблонов уведомлений. Поэтому избегайте использования имён, уже определённых как шаблоны по умолчанию, таких как: __subject, __text_values_list, __text_alert_list, default.title и default.message.

Чтобы создать шаблон уведомления в Grafana, выполните следующие шаги.

1. Нажмите Alerts & IRM -> Contact points.

2. Нажмите вкладку Notification Templates, затем + New notification template.

3. Введите имя группы шаблонов уведомлений.

4. Напишите содержимое шаблона в поле содержимого.

5. Сохраните изменения.

   Если {{ define }} не включено в содержимое, {{ define "<NOTIFICATION_TEMPLATE_NAME>" }} и {{ end }} автоматически добавляются в начало и конец.

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

1. Нажмите + New notification template.

2. Введите имя группы шаблонов уведомлений.

3. Напишите каждый шаблон в поле Content, включая {{ define "<NOTIFICATION_TEMPLATE_NAME>" }} и {{ end }} в начале и конце каждого шаблона.

4. Сохраните изменения.

Подробнее о том, как писать шаблоны уведомлений, см. в справочнике по шаблонам и примерах.

Предпросмотр шаблона уведомления

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

Чтобы посмотреть предпросмотр ваших шаблонов уведомлений:

1. Перейдите в Alerts & IRM -> Alerting -> Notification configuration, затем выберите вкладку Templates.

2. Нажмите + New notification template или отредактируйте существующую группу шаблонов.

3. Добавьте или обновите содержимое вашего шаблона.

   Данные по умолчанию предоставляются, и вы можете добавлять или редактировать в них данные оповещений, а также экземпляры оповещений. Вы можете добавить данные оповещений прямо в окне Payload data или нажать Select alert instances или Add custom alerts.

4. Необязательно: чтобы добавить данные оповещений из существующих экземпляров оповещений:

   a. Нажмите Select alert instances.

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

   c. Нажмите Confirm, чтобы добавить экземпляр(ы) оповещения в полезную нагрузку.

5. Необязательно: чтобы добавить данные оповещений с помощью редактора Alert data, нажмите Add custom data:

   a. Добавьте аннотации, пользовательские метки и/или задайте дашборд или панель.

   b. Переключите Firing/resolved в зависимости от того, хотите вы добавить сработавшие или разрешившиеся оповещения в ваше уведомление.

   c. Нажмите Add alert data.

   d. Нажмите Refresh preview, чтобы увидеть, как должно выглядеть содержимое вашего шаблона, и соответствующие данные полезной нагрузки.

   Если в вашем шаблоне есть ошибки, они отображаются в Preview, и вы можете исправить их перед сохранением.

6. Сохраните изменения.