建立通知範本 - 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. 按一下 Save (儲存)。

    {{ define "email.subject" }}（其中email.subject是模板的名稱），並{{ end }}自動添加到內容的開頭和結尾。

若要建立包含多個範本的通知範本，請執行下列動作：

  1. 按一下新增範本。

  2. 輸入整體通知範本的名稱。例如 email。

  3. 在「內容」欄位中寫入每個範本{{ define "name-of-template" }}，包括每個範本的開頭和結尾{{ end }}處。您可以為通知範本中的每個範本使用描述性名稱，例如，email.subject或email.message。在此情況下，請勿重複使用您在上面輸入的通知範本名稱。

    以下各節顯示您可能建立的範本的詳細範例。

  4. 按一下 Save (儲存)。

建立電子郵件主旨的範本

為包含觸發和已解決警示數目的電子郵件主旨建立範本，如下列範例所示：

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模板用於打印標籤，註釋和儀表板 Durl，而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" . }}，將 template_name 取代為您要使用的範本名稱。

  4. 按一下「儲存聯絡點」。