菜单
Grafana Cloud Enterprise Open source

管理通知模板

在联系点中,您可以选择通知模板来自定义发送的通知消息。

默认情况下,Grafana 为通知标题({{define "default.title"}})和通知消息({{define "default.message"}})提供了一个模板。这两个默认模板都显示常见的告警详细信息。

您还可以创建自定义模板,来自定义通知消息的内容和格式,然后将其应用于一个或多个联系点。在 Grafana 中,自定义通知模板是在通知模板组中创建的。

本文档提供了在联系点中选择模板、预览模板以及使用 Grafana UI 创建通知模板组的分步说明。

为联系点选择通知模板

要向您的联系点添加现有通知模板,请完成以下步骤。

  1. 点击现有联系点或创建一个新联系点。

  2. 可选设置中,点击包含模板的任何字段。

    例如,如果您正在创建电子邮件联系点集成,请点击消息主题

  3. 点击编辑。将打开一个对话框,您可以在其中选择通知模板。

  4. 点击选择通知模板输入自定义消息以自定义模板或消息

    • 您可以选择现有通知模板,并使用默认负载对其进行预览
    • 您还可以复制通知模板,并在输入自定义消息选项卡中使用它。
  5. 点击保存联系点

创建通知模板和通知模板组

创建通知模板来自定义通知消息并在联系点中重复使用。

在 Grafana 中,自定义通知模板({{define "<NAME>"}})是在通知模板组中创建的,这使您可以一起测试和实现多个模板。

您的通知模板名称({{define "<NAME>"}})必须唯一。您不能在同一个通知模板组或不同的通知模板组中有两个同名模板。因此,请避免使用已定义为默认模板的名称,例如:__subject__text_values_list__text_alert_listdefault.titledefault.message

要在 Grafana 中创建通知模板,请完成以下步骤。

  1. 点击告警与 IRM -> 联系点

  2. 点击通知模板选项卡,然后点击+ 添加通知模板组

  3. 输入通知模板组的名称。

  4. 在内容字段中编写模板的内容。

  5. 保存您的更改。

    如果内容中未包含 {{ define }},则会自动在开头和结尾添加 {{ define "<NOTIFICATION_TEMPLATE_NAME>" }}{{ end }}

要创建包含多个通知模板的通知模板组,请完成以下步骤。

  1. 点击+ 添加通知模板组

  2. 输入通知模板组的名称。

  3. 在内容字段中编写每个模板,并在每个模板的开头和结尾包含 {{ define "<NOTIFICATION_TEMPLATE_NAME>" }}{{ end }}

  4. 保存您的更改。

有关如何编写通知模板的更多详细信息,请参阅模板参考示例

预览通知模板

在联系点中使用通知模板之前预览它们的外观,这有助于您了解正在创建的模板结果,并使您能够在保存之前修复任何错误。

注意

通知模板预览仅适用于 Grafana Alertmanager。

预览您的通知模板

  1. 导航至告警与 IRM -> 告警 -> 联系点 -> 通知模板

  2. 点击+ 添加通知模板组或编辑现有模板组。

  3. 添加或更新您的模板内容。

    提供了默认数据,您可以添加或编辑告警数据以及告警实例。您可以直接在“负载数据”窗口中添加告警数据,或点击选择告警实例添加自定义告警

  4. 可选:从现有告警实例添加告警数据

    a. 点击选择告警实例

    b. 将鼠标悬停在告警实例上,以查看每个告警实例的更多信息。

    c. 点击确认将告警实例添加到负载中。

  5. 可选:使用告警数据编辑器添加告警数据,点击添加自定义数据:

    a. 添加注解、自定义标签和/或设置仪表盘或面板。

    b. 根据您是要将正在触发的还是已解决的告警添加到通知中,切换“正在触发/已解决”。

    c. 点击添加告警数据

    d. 点击刷新预览,查看您的模板内容应该是什么样子以及相应的负载数据。

    如果模板中有任何错误,将在预览中显示,您可以在保存之前进行修正。

  6. 保存您的更改。