Документацияbreadcrumb arrow Grafanabreadcrumb arrow Документация GlaberGraphbreadcrumb arrow Оповещенияbreadcrumb arrow Дополнительная конфигурацияbreadcrumb arrow Провижининг ресурсов Alertingbreadcrumb arrow Экспорт ресурсов оповещений

Export alerting resources

Экспортируйте ваши ресурсы оповещений, такие как правила оповещения, contact points и политики уведомлений, для провижининга, автоматически импортируя отдельные папки и отдельные группы.

Существуют различные способы экспорта ваших ресурсов оповещений:

Note

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

Если вам нужно изменить провижиненные ресурсы оповещений в Grafana, обратитесь к разделу редактирование ресурсов оповещений HTTP API в интерфейсе Grafana или к разделу редактирование ресурсов оповещений Terraform в интерфейсе Grafana.

Export from the Grafana UI

Перечисленные ниже параметры экспорта позволяют загружать ресурсы в формате YAML, JSON или Terraform, что облегчает их провижининг через файлы конфигурации или Terraform.

Export alert rules

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

  1. Нажмите Alerts & IRM -> Alert rules.

  2. Чтобы экспортировать все Grafana-managed правила, нажмите Export rules.

  3. Чтобы экспортировать папку, измените View as на List.

  4. Выберите папку, которую хотите экспортировать, и нажмите значок Export rules folder.

  5. Чтобы экспортировать группу, измените View as на Grouped.

  6. Найдите группу, которую хотите экспортировать, и нажмите значок Export rule group.

  7. Выберите формат экспорта.

    Экспортированные данные правил оповещения отображаются в разных форматах — YAML, JSON, Terraform.

  8. Нажмите Copy Code или Download.

Modify alert rule and export rule group without saving changes

Note

Эта функция предназначена только для Grafana-managed правил оповещения. Она доступна ролям Admin, Viewer и Editor.

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

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

  1. Нажмите Alerts & IRM -> Alert rules.

  2. Найдите правило оповещения, которое хотите отредактировать, и нажмите More -> Modify Export, чтобы открыть форму Alert Rule.

  3. В форме Alert Rule отредактируйте поля, которые хотите изменить. Внесённые изменения не применяются к правилу оповещения.

  4. Нажмите Export.

  5. Выберите формат экспорта.

    Экспортированная группа правил оповещения отображается в разных форматах — YAML, JSON, Terraform.

  6. Нажмите Copy Code или Download.

Export a new alert rule definition without saving changes

Note

Экспорт возможен только в формате Terraform (HCL).

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

Определение правила оповещения отличается от правила оповещения тем, что вы определяете своё правило оповещения, но не сохраняете его. Оно становится сохранённым правилом оповещения только после того, как вы провижините его с помощью Terraform.

Чтобы экспортировать определение вашего правила оповещения в формат Terraform (HCL), выполните следующие шаги.

  1. Нажмите Alerts & IRM -> Alert rules.
  2. Нажмите Export rule definition.
  3. Заполните сведения о правиле оповещения.
  4. Выберите провижиненную папку и группу, в которые хотите добавить определение вашего правила оповещения.
  5. Нажмите Export.
  6. Скопируйте и вставьте код в ваш конвейер Terraform, чтобы создать новое правило оповещения.

Export contact points

Чтобы экспортировать contact points из интерфейса Grafana, выполните следующие шаги.

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

  2. Найдите contact point, который хотите экспортировать, и нажмите More -> Export.

  3. Выберите формат экспорта.

    Экспортированный contact point отображается в разных форматах — YAML, JSON, Terraform.

  4. Нажмите Copy Code или Download.

Export notification template groups

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

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

  1. Нажмите Alerts & IRM -> Contact points -> вкладка Notification templates.
  2. Найдите группу шаблонов уведомлений, которую хотите экспортировать.
  3. Скопируйте содержимое и имя.
  4. Приведите их к формату файлового провижининга или ресурсу Terraform.

Export the notification policy tree

Все политики уведомлений провижинятся через единый ресурс: корень дерева политик уведомлений.

Warning

Since the policy tree is a single resource, provisioning it will overwrite all policies in the notification policy tree. However, it does not affect internal policies created when alert rules directly select a contact point.

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

  1. Нажмите Alerts & IRM -> Notification policies.

  2. В разделе Default notification policy нажмите … -> Export.

  3. Выберите формат экспорта.

    Экспортированное дерево политик уведомлений отображается в разных форматах — YAML, JSON, Terraform.

  4. Нажмите Copy Code или Download.

Вы также можете экспортировать отдельные именованные деревья маршрутизации.

  1. Нажмите Alerts & IRM -> Notification policies.
  2. Найдите дерево маршрутизации, которое хотите экспортировать, в списке.
  3. Нажмите пункт меню More actions и выберите Export.
  4. Выберите формат экспорта и нажмите Copy Code или Download.

Export mute timings

Чтобы экспортировать mute timings из интерфейса Grafana, выполните следующие шаги.

  1. Нажмите Alerts & IRM -> Notification policies, а затем вкладку Mute timings.

  2. Найдите mute timing, который хотите экспортировать, и нажмите Export.

  3. Выберите формат экспорта.

    Экспортированный contact point отображается в разных форматах — YAML, JSON, Terraform.

  4. Нажмите Copy Code или Download.

HTTP Alerting API

Вы можете использовать Alerting HTTP API для получения существующих ресурсов оповещений в формате JSON и импорта их в другой экземпляр Grafana с использованием той же конечной точки.

Ресурс URI
Правила оповещения /api/v1/provisioning/alert-rules
Contact points /api/v1/provisioning/contact-points
Дерево политик уведомлений /api/v1/provisioning/policies
Группы шаблонов уведомлений /api/v1/provisioning/templates
Mute timings /api/v1/provisioning/mute-timings

Однако обратите внимание, что стандартные конечные точки возвращают формат JSON, несовместимый с провижинингом через файлы конфигурации или Terraform, за исключением перечисленных ниже конечных точек /export.

Export API endpoints

Alerting HTTP API предоставляет специальные конечные точки для экспорта ресурсов оповещений в YAML или JSON, что облегчает провижининг через файлы конфигурации или Terraform (HCL).

Ресурс Метод / URI Краткое описание
Правила оповещения GET /api/v1/provisioning/alert-rules/export Экспорт всех правил оповещения в формате файла провижининга.
Правила оповещения GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export Экспорт группы правил оповещения в формате файла провижининга.
Правила оповещения GET /api/v1/provisioning/alert-rules/:uid/export Экспорт правила оповещения в формате файла провижининга.
Contact points GET /api/v1/provisioning/contact-points/export Экспорт всех contact points в формате файла провижининга.
Дерево политик уведомлений GET /api/v1/provisioning/policies/export Экспорт дерева политик уведомлений в формате файла провижининга.
Mute timings GET /api/v1/provisioning/mute-timings/export Экспорт всех mute timings в формате файла провижининга.
Mute timings GET /api/v1/provisioning/mute-timings/:name/export Экспорт mute timing в формате файла провижининга.

Эти конечные точки принимают параметр download для загрузки файла, содержащего экспортированные ресурсы.