创建通知模板 - Amazon Managed Grafana
创建通知模板为电子邮件主题创建模板为电子邮件消息创建模板为 Slack 消息的标题创建模板为 Slack 消息的内容创建模板使用共享模板同时使用电子邮件和 Slack 进行模板使用通知模板

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

创建通知模板

本文档主题专为支持 Grafana 9.x 版本的 Grafana 工作空间而设计。

有关支持 Grafana 版本 10.x 的 Grafana 工作空间，请参阅。在 Grafana 版本 10 中工作

有关支持 Grafana 8.x 版本的 Grafana 工作空间，请参阅。在 Grafana 版本 8 中工作

创建可重复使用的通知模板以发送给您的联系人。

您可以向通知模板中添加一个或多个模板。

您的通知模板名称必须是唯一的。在同一个通知模板或不同的通知模板中，不能有两个同名的模板。避免定义与默认模板同名的模板，例如：__subject、__text_values_list__text_alert_list、default.title和default.message。

在 “联系方式” 选项卡中，您可以看到通知模板列表。

创建通知模板

创建通知模板

  1. 单击 “添加模板”。

  2. 为通知模板选择一个名称，例如email.subject。

  3. 在内容字段中写下模板的内容。

    例如：

    {{ if .Alerts.Firing -}}
   {{ len .Alerts.Firing }} firing alerts
   {{ end }}
   {{ if .Alerts.Resolved -}}
   {{ len .Alerts.Resolved }} resolved alerts
   {{ end }}

  4. 单击保存。

    {{ define "email.subject" }}（其中email.subject是您的模板名称），并{{ end }}自动添加到内容的开头和结尾。

要创建包含多个模板的通知模板，请执行以下操作：

  1. 单击 “添加模板”。

  2. 输入整个通知模板的名称。例如，email。

  3. 在 “内容” 字段中写下每个模板，包括{{ define "name-of-template" }}每个模板的开头和结尾{{ end }}处和。您可以为通知模板中的每个模板使用描述性名称，例如，email.subject或email.message。在这种情况下，请勿重复使用您在上面输入的通知模板的名称。

    以下各节显示了您可能创建的模板的详细示例。

  4. 单击保存。

为电子邮件主题创建模板

为电子邮件的主题创建包含触发和已解决警报数量的模板，如以下示例所示：

1 firing alerts, 0 resolved alerts
为电子邮件主题创建模板

  1. 创建一个名为的模板email.subject，其中包含以下内容：

    {{ define "email.subject" }}
{{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
{{ end }}

  2. 在创建联络点集成时使用该模板，方法是将其放入带有template关键字的 “主题” 字段中。

    {{ template "email.subject" . }}

为电子邮件消息创建模板

为电子邮件消息创建模板，其中包含所有触发警报和已解决警报的摘要，如以下示例所示：

There are 2 firing alerts, and 1 resolved alerts

Firing alerts:

- alertname=Test 1 grafana_folder=GrafanaCloud has value(s) B=1
- alertname=Test 2 grafana_folder=GrafanaCloud has value(s) B=2

Resolved alerts:

- alertname=Test 3 grafana_folder=GrafanaCloud has value(s) B=0
为电子邮件消息创建模板

  1. 创建一个名为email的通知模板，其中包含两个模板：email.message_alert和email.message。

    email.message_alert模板用于打印每个触发和已解决警报的标签和值，而email.message模板包含电子邮件的结构。

    {{- define "email.message_alert" -}}
{{- range .Labels.SortedPairs }}{{ .Name }}={{ .Value }} {{ end }} has value(s)
{{- range $k, $v := .Values }} {{ $k }}={{ $v }}{{ end }}
{{- end -}}

{{ define "email.message" }}
There are {{ len .Alerts.Firing }} firing alerts, and {{ len .Alerts.Resolved }} resolved alerts

{{ if .Alerts.Firing -}}
Firing alerts:
{{- range .Alerts.Firing }}
- {{ template "email.message_alert" . }}
{{- end }}
{{- end }}

{{ if .Alerts.Resolved -}}
Resolved alerts:
{{- range .Alerts.Resolved }}
- {{ template "email.message_alert" . }}
{{- end }}
{{- end }}

{{ end }}

  2. 在创建联络点集成时使用该模板，方法是将其输入到带有template关键字的 “文本正文” 字段中。

    {{ template "email.message" . }}

为 Slack 消息的标题创建模板

为 Slack 消息的标题创建一个模板，其中包含触发和已解决的警报数量，如以下示例所示：

1 firing alerts, 0 resolved alerts
为 Slack 消息的标题创建模板

  1. 创建一个名为的模板slack.title，其中包含以下内容：

    {{ define "slack.title" }}
{{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
{{ end }}

  2. 在创建联络点集成时使用该模板，方法是将其放入带有template关键字的 “标题” 字段中。

    {{ template "slack.title" . }}

为 Slack 消息的内容创建模板

为 Slack 消息的内容创建模板，其中包含所有触发和已解决警报的描述，包括其标签、注释和控制面板 URL：

1 firing alerts:

[firing] Test1
Labels:
- alertname: Test1
- grafana_folder: GrafanaCloud
Annotations:
- description: This is a test alert
Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1

1 resolved alerts:

[firing] Test2
Labels:
- alertname: Test2
- grafana_folder: GrafanaCloud
Annotations:
- description: This is another test alert
Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1
为 Slack 消息的内容创建模板

  1. 创建一个名为slack的模板，内容中包含两个模板：slack.print_alert和slack.message。

    slack.print_alert模板用于打印标签、注释和 DashboardUrl，而slack.message模板则包含通知的结构。

    {{ define "slack.print_alert" -}}
[{{.Status}}] {{ .Labels.alertname }}
Labels:
{{ range .Labels.SortedPairs -}}
- {{ .Name }}: {{ .Value }}
{{ end -}}
{{ if .Annotations -}}
Annotations:
{{ range .Annotations.SortedPairs -}}
- {{ .Name }}: {{ .Value }}
{{ end -}}
{{ end -}}
{{ if .DashboardURL -}}
  Go to dashboard: {{ .DashboardURL }}
{{- end }}
{{- end }}

{{ define "slack.message" -}}
{{ if .Alerts.Firing -}}
{{ len .Alerts.Firing }} firing alerts:
{{ range .Alerts.Firing }}
{{ template "slack.print_alert" . }}
{{ end -}}
{{ end }}
{{ if .Alerts.Resolved -}}
{{ len .Alerts.Resolved }} resolved alerts:
{{ range .Alerts.Resolved }}
{{ template "slack.print_alert" .}}
{{ end -}}
{{ end }}
{{- end }}

  2. 在创建联络点集成时使用该模板，方法是将其输入到带有template关键字的 “文本正文” 字段中。

    {{ template "slack.message" . }}

使用共享模板同时使用电子邮件和 Slack 进行模板

您可以共享相同的模板，而不必为每个联系人创建单独的通知模板，例如电子邮件和 Slack。

例如，如果您想发送带有此主题的电子邮件和带有此标题的 Slack 消息1 firing alerts, 0 resolved alerts，则可以创建共享模板。

创建共享模板

  1. 创建一个名为的模板common.subject_title，其中包含以下内容：

    {{ define "common.subject_title" }}
{{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
{{ end }}

  2. 对于电子邮件，请在电子邮件联系点集成中的主题字段中运行模板：

    {{ template "common.subject_title" . }}

  3. 对于 Slack，请从 Slack 联络点集成的标题字段中运行模板：

    {{ template "common.subject_title" . }}

使用通知模板

使用联系人中的模板来自定义您的通知。

在创建联系人时使用模板

  1. 从 “提醒” 菜单中，选择 “联系人” 以查看现有联系人列表。

  2. 选择添加联系人。或者，您可以通过选择要编辑的联系人旁边的编辑图标（笔）来编辑现有的联系人。

  3. 在一个或多个字段中输入您要使用的模板，例如 “消息” 或 “主题”。要输入模板，请使用表单{{ template "template_name" . }}，将 t emplate_name 替换为要使用的模板的名称。

  4. 单击 “保存联系人”。