Vorlagen für Benachrichtigungen erstellen

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

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

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. Wählen Sie das Verwaltungsportal für Benachrichtigungen IRM, Kontaktstellen aus.

2. Wählen Sie die Registerkarte Benachrichtigungsvorlagen und dann + Benachrichtigungsvorlage hinzufügen.

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

4. 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 }}

5. Speichern Sie Ihre Änderungen.

   {{ 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. Wählen Sie das Verwaltungsportal für Benachrichtigungen IRM, Kontaktstellen aus.

2. Wählen Sie die Registerkarte Benachrichtigungsvorlagen und dann + Benachrichtigungsvorlage hinzufügen.

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

4. 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 späteren Abschnitten finden Sie detaillierte Beispiele für Vorlagen, die Sie möglicherweise erstellen.

5. Klicken Sie auf Speichern.

Eine Vorschau der Vorlagen für Benachrichtigungen anzeigen

Sehen Sie sich eine Vorschau Ihrer Benachrichtigungsvorlagen an, bevor Sie sie in Ihren Kontaktstellen verwenden. Dies hilft Ihnen, das Ergebnis der von Ihnen erstellten Vorlage zu verstehen, und gibt Ihnen die Möglichkeit, etwaige Fehler zu beheben, bevor Sie die Vorlage speichern.

Anmerkung

Benachrichtigungsvorschauen sind nur für Grafana Alertmanager verfügbar.

Um eine Vorschau Ihrer Benachrichtigungsvorlagen anzuzeigen

1. Wählen Sie das Verwaltungsportal für Benachrichtigungen IRM und Kontaktstellen aus.

2. Wählen Sie die Registerkarte Benachrichtigungsvorlagen und dann + Benachrichtigungsvorlage hinzufügen oder bearbeiten Sie eine vorhandene Vorlage.

3. Fügen Sie den Inhalt Ihrer Vorlage hinzu oder aktualisieren Sie sie.

   Standarddaten werden bereitgestellt, und Sie können Warndaten sowie Warnungsinstanzen hinzufügen oder bearbeiten. Sie können Warndaten direkt im Payload-Datenfenster selbst hinzufügen oder auf Warnungsinstanzen auswählen oder Benutzerdefinierte Benachrichtigungen hinzufügen klicken.

4. [Optional] So fügen Sie Warnungsdaten aus vorhandenen Warnungsinstanzen hinzu:

   1. Wählen Sie „Warnungsinstanzen auswählen“.

   2. Bewegen Sie den Mauszeiger über die Warnungsinstanzen, um weitere Informationen zu jeder Warnungsinstanz anzuzeigen/

   3. Wählen Sie Bestätigen, um die Warnungsinstanz zur Payload hinzuzufügen.

5. [Optional] Um Warnungsdaten mit dem Alert-Dateneditor hinzuzufügen, wählen Sie Benutzerdefinierte Daten hinzufügen aus:

   1. Fügen Sie Anmerkungen und benutzerdefinierte Beschriftungen hinzu oder richten Sie ein Dashboard oder einen Bereich ein.

   2. Aktiviere „Ausgelöst“ oder „Gelöst“, je nachdem, ob du deiner Benachrichtigung ausgelöste oder gelöste Warnmeldungen hinzufügen möchtest.

   3. Wähle „Warnungsdaten hinzufügen“.

   4. Wählen Sie Vorschau aktualisieren, um zu sehen, wie der Inhalt Ihrer Vorlage aussehen wird und welche Payload-Daten dazu gehören.

   Wenn Ihre Vorlage Fehler enthält, werden diese in der Vorschau angezeigt und Sie können sie vor dem Speichern korrigieren.

6. Speichern Sie Ihre Änderungen.

Eine Vorlage für den Betreff der Nachricht 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" . }}

Eine Vorlage für die Nachricht einer E-Mail erstellen

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. Führen Sie die Vorlage über das Titelfeld in Ihrer Kontaktpunktintegration aus.

   {{ 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.

Anmerkung

Diese Vorlage ist nur für von Grafana verwaltete Benachrichtigungen vorgesehen. Um die Vorlage für von Datenquellen verwaltete Benachrichtigungen zu verwenden, löschen Sie die Verweise auf dashboardURL und silenceUrl. Weitere Informationen zur Konfiguration von Prometheus-Benachrichtigungen finden Sie in der Prometheus-Dokumentation zu Benachrichtigungen.

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. Führen Sie die Vorlage über das Textfeld in Ihrer Kontaktpunktintegration aus:

   {{ 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 wie E-Mail und Slack zu erstellen, 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" . }}