Vorlagen für Benachrichtigungen erstellen

Dieses Dokumentationsthema wurde für Grafana-Workspaces entwickelt, die Grafana-Version 9.x unterstützen.

Informationen zu Grafana-Arbeitsbereichen, die Grafana-Version 10.x unterstützen, finden Sie unter. Arbeitet in Grafana-Version 10

Informationen zu Grafana-Arbeitsbereichen, die Grafana-Version 8.x unterstützen, finden Sie unter. Arbeitet in Grafana-Version 8

Erstellen Sie wiederverwendbare Benachrichtigungsvorlagen, die Sie an Ihre Kontaktstellen senden können.

Sie können Ihrer Benachrichtigungsvorlage eine oder mehrere Vorlagen hinzufügen.

Der Name Ihrer Benachrichtigungsvorlage muss eindeutig sein. Sie können nicht zwei Vorlagen mit demselben Namen in derselben Benachrichtigungsvorlage oder in verschiedenen Benachrichtigungsvorlagen haben. Vermeiden Sie es, Vorlagen mit demselben Namen wie Standardvorlagen zu definieren, z. B.: __subject__text_values_list,__text_alert_list, default.title unddefault.message.

Auf der Registerkarte Kontaktstellen finden Sie eine Liste Ihrer Benachrichtigungsvorlagen.

Vorlagen für Benachrichtigungen erstellen

Um eine Benachrichtigungsvorlage zu erstellen

1. Klicken Sie auf Vorlage hinzufügen.

2. Wählen Sie einen Namen für die Benachrichtigungsvorlage, z. email.subject B.

3. Schreiben Sie den Inhalt der Vorlage in das Inhaltsfeld.

   Beispielsweise:

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

4. Klicken Sie auf Speichern.

   {{ define "email.subject" }}(wo email.subject ist der Name Ihrer Vorlage) und {{ end }} wird automatisch am Anfang und Ende des Inhalts hinzugefügt.

Um eine Benachrichtigungsvorlage zu erstellen, die mehr als eine Vorlage enthält:

1. Klicken Sie auf Vorlage hinzufügen.

2. Geben Sie einen Namen für die gesamte Benachrichtigungsvorlage ein. z. B. email.

3. Schreiben Sie jede Vorlage in das Feld Inhalt, einschließlich {{ define "name-of-template" }} und {{ end }} am Anfang und Ende jeder Vorlage. Sie können für jede Vorlage in der Benachrichtigungsvorlage aussagekräftige Namen verwenden, z. B. email.subject oderemail.message. Verwenden Sie in diesem Fall nicht den Namen der Benachrichtigungsvorlage, den Sie oben eingegeben haben.

   In den folgenden Abschnitten finden Sie detaillierte Beispiele für Vorlagen, die Sie erstellen könnten.

4. Klicken Sie auf Speichern.

Eine Vorlage für den Betreff einer E-Mail erstellen

Erstellen Sie eine Vorlage für den Betreff einer E-Mail, die die Anzahl der ausgelösten und gelösten Benachrichtigungen enthält, wie in diesem Beispiel:

1 firing alerts, 0 resolved alerts

Um eine Vorlage für den Betreff einer E-Mail zu erstellen

1. Erstellen Sie eine Vorlage namens email.subject mit dem folgenden Inhalt:

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

2. Verwenden Sie die Vorlage bei der Erstellung Ihrer Kontaktpunktintegration, indem Sie sie in das Feld Betreff mit dem template Schlüsselwort einfügen.

   {{ template "email.subject" . }}

Erstellen Sie eine Vorlage für die Nachricht einer E-Mail

Erstellen Sie eine Vorlage für die Nachricht einer E-Mail, die eine Zusammenfassung aller ausgelösten und gelösten Alarme enthält, wie in diesem Beispiel:

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

Um eine Vorlage für die Nachricht einer E-Mail zu erstellen

1. Erstellen Sie eine Benachrichtigungsvorlage email mit zwei Vorlagen im Inhalt: email.message_alert undemail.message.

   Die email.message_alert Vorlage wird verwendet, um die Bezeichnungen und Werte für jede ausgelöste und behobene Warnung zu drucken, wobei die email.message Vorlage die Struktur der E-Mail enthält.

   {{- 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. Verwenden Sie die Vorlage bei der Erstellung Ihrer Kontaktpunktintegration, indem Sie sie in das Textfeld mit dem template Schlüsselwort einfügen.

   {{ template "email.message" . }}

Eine Vorlage für den Titel einer Slack-Nachricht erstellen

Erstelle eine Vorlage für den Titel einer Slack-Nachricht, die die Anzahl der ausgelösten und gelösten Alerts enthält, wie im folgenden Beispiel:

1 firing alerts, 0 resolved alerts

Um eine Vorlage für den Titel einer Slack-Nachricht zu erstellen

1. Erstelle eine Vorlage namens slack.title mit dem folgenden Inhalt:

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

2. Verwenden Sie die Vorlage bei der Erstellung Ihrer Kontaktpunktintegration, indem Sie sie in das Titelfeld mit dem template Schlüsselwort einfügen.

   {{ template "slack.title" . }}

Eine Vorlage für den Inhalt einer Slack-Nachricht erstellen

Erstelle eine Vorlage für den Inhalt einer Slack-Nachricht, die eine Beschreibung aller ausgelösten und gelösten Alerts enthält, einschließlich ihrer Labels, Anmerkungen und Dashboard-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

Um eine Vorlage für den Inhalt einer Slack-Nachricht zu erstellen

1. Erstelle ein Template namens slack mit zwei Templates im Inhalt: slack.print_alert undslack.message.

   Die slack.print_alert Vorlage wird zum Drucken der Beschriftungen, Anmerkungen und der Dashboard-URL verwendet, während die slack.message Vorlage die Struktur der Benachrichtigung enthält.

   {{ 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. Verwenden Sie die Vorlage bei der Erstellung Ihrer Kontaktpunktintegration, indem Sie sie in das Feld Textkörper mit dem Schlüsselwort einfügen. template

   {{ template "slack.message" . }}

Template sowohl für E-Mail als auch für Slack mit gemeinsam genutzten Vorlagen

Anstatt separate Benachrichtigungsvorlagen für jeden Kontaktpunkt zu erstellen, z. B. E-Mail und Slack, kannst du dieselbe Vorlage gemeinsam nutzen.

Wenn du beispielsweise eine E-Mail mit diesem Betreff und eine Slack-Nachricht mit diesem Titel senden möchtest1 firing alerts, 0 resolved alerts, kannst du eine gemeinsame Vorlage erstellen.

Um eine gemeinsame Vorlage zu erstellen

1. Erstellen Sie eine Vorlage namens common.subject_title mit dem folgenden Inhalt:

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

2. Führen Sie für E-Mails die Vorlage im Betreff-Feld Ihrer E-Mail-Kontaktpunkt-Integration aus:

   {{ template "common.subject_title" . }}

3. Für Slack führe die Vorlage im Titelfeld deiner Slack-Kontaktpunkt-Integration aus:

   {{ template "common.subject_title" . }}

Verwenden von Benachrichtigungsvorlagen

Verwenden Sie Vorlagen in Kontaktpunkten, um Ihre Benachrichtigungen zu personalisieren.

Um eine Vorlage beim Erstellen einer Kontaktstelle zu verwenden

1. Wählen Sie im Menü „Benachrichtigungen“ die Option Kontaktstellen aus, um eine Liste der vorhandenen Kontaktstellen anzuzeigen.

2. Wählen Sie Kontaktstelle hinzufügen. Alternativ können Sie eine bestehende Kontaktstelle bearbeiten, indem Sie neben der Kontaktstelle, die Sie bearbeiten möchten, auf das Symbol Bearbeiten (Stift) klicken.

3. Geben Sie die Vorlagen, die Sie verwenden möchten, in ein oder mehrere Felder ein, z. B. Nachricht oder Betreff. Um eine Vorlage einzugeben, verwenden Sie das Formular {{ template "template_name" . }} und ersetzen Sie template_name durch den Namen der Vorlage, die Sie verwenden möchten.

4. Klicken Sie auf Kontaktstelle speichern.