Création de modèles de notification Afficher un aperçu des modèles de notification Création d'un modèle pour l'objet du message Création d'un modèle pour le message d'un e-mail Création d'un modèle pour le titre d'un message Slack Création d'un modèle pour le contenu d'un message Slack Modélisez à la fois vos e-mails et Slack avec des modèles partagés

Création de modèles de notification

Cette rubrique de documentation est conçue pour les espaces de travail Grafana qui prennent en charge la version 10.x de Grafana.

Pour les espaces de travail Grafana compatibles avec la version 9.x de Grafana, voir. Travailler dans la version 9 de Grafana

Pour les espaces de travail Grafana compatibles avec la version 8.x de Grafana, voir. Travailler dans la version 8 de Grafana

Créez des modèles de notification réutilisables à envoyer à vos points de contact.

Vous pouvez ajouter un ou plusieurs modèles à votre modèle de notification.

Le nom de votre modèle de notification doit être unique. Vous ne pouvez pas avoir deux modèles portant le même nom dans le même modèle de notification ou dans des modèles de notification différents. Évitez de définir des modèles portant le même nom que les modèles par défaut, tels que : __subject__text_values_list,__text_alert_list, default.title etdefault.message.

Dans l'onglet Points de contact, vous pouvez voir la liste de vos modèles de notification.

Création de modèles de notification

Pour créer un modèle de notification

Choisissez Portail de gestion des alertes IRM, Points de contact.
Choisissez l'onglet Modèles de notification, puis + Ajouter un modèle de notification.
Choisissez un nom pour le modèle de notification, par exempleemail.subject.

Écrivez le contenu du modèle dans le champ de contenu.

Par exemple :


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

Enregistrez vos modifications.

{{ define "email.subject" }}(où email.subject est le nom de votre modèle) et {{ end }} est automatiquement ajouté au début et à la fin du contenu.

Pour créer un modèle de notification contenant plusieurs modèles

Choisissez Portail de gestion des alertes IRM, Points de contact.
Choisissez l'onglet Modèles de notification, puis + Ajouter un modèle de notification.
Entrez un nom pour le modèle de notification global. Par exemple, email.
Écrivez chaque modèle dans le champ Contenu, y compris {{ define "name-of-template" }} {{ end }} au début et à la fin de chaque modèle. Vous pouvez utiliser des noms descriptifs pour chacun des modèles du modèle de notification, par exemple, email.subject ouemail.message. Dans ce cas, ne réutilisez pas le nom du modèle de notification que vous avez saisi ci-dessus.

Les sections suivantes présentent des exemples détaillés de modèles que vous pourriez créer.
Cliquez sur Sauvegarder

Afficher un aperçu des modèles de notification

Prévisualisez l'apparence de vos modèles de notification avant de les utiliser dans vos points de contact, afin de comprendre le résultat du modèle que vous créez et de corriger les erreurs éventuelles avant de l'enregistrer.

Note

Les aperçus des notifications ne sont disponibles que pour Grafana Alertmanager.

Pour prévisualiser vos modèles de notification

Choisissez Portail de gestion des alertes IRM, Points de contact.
Choisissez l'onglet Modèles de notification, puis + Ajouter un modèle de notification ou modifiez un modèle existant.
Ajoutez ou mettez à jour le contenu de votre modèle.

Les données par défaut sont fournies et vous pouvez y ajouter ou modifier des données d'alerte ainsi que des instances d'alerte. Vous pouvez ajouter des données d'alerte directement dans la fenêtre de données de charge utile elle-même, ou cliquer sur Sélectionner des instances d'alerte ou sur Ajouter des alertes personnalisées.
[Facultatif] Pour ajouter des données d'alerte provenant d'instances d'alerte existantes :
1. Choisissez Sélectionner les instances d'alerte.
2. Passez le curseur sur les instances d'alerte pour afficher plus d'informations sur chaque instance d'alerte/
3. Choisissez Confirm pour ajouter l'instance d'alerte à la charge utile.
[Facultatif] Pour ajouter des données d'alerte à l'aide de l'éditeur de données d'alerte, choisissez Ajouter des données personnalisées :
1. Ajoutez des annotations, des étiquettes personnalisées ou définissez un tableau de bord ou un panneau.
2. Activez le mode Déclenchement ou Résolu, selon que vous souhaitez ajouter des alertes déclenchées ou résolues à votre notification.
3. Choisissez Ajouter des données d'alerte.
4. Choisissez Actualiser l'aperçu pour voir à quoi ressemblera le contenu de votre modèle et les données de charge utile correspondantes.
Si votre modèle contient des erreurs, elles sont affichées dans l'aperçu et vous pouvez les corriger avant de les enregistrer.
Enregistrez vos modifications.

Création d'un modèle pour l'objet du message

Créez un modèle pour l'objet d'un e-mail contenant le nombre d'alertes déclenchées et résolues, comme dans cet exemple :


1 firing alerts, 0 resolved alerts

Pour créer un modèle pour l'objet d'un e-mail

Créez un modèle appelé email.subject avec le contenu suivant :


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

Utilisez le modèle lors de la création de votre intégration de points de contact en le plaçant dans le champ Objet avec le template mot clé.
```
{{ template "email.subject" . }}
```

Création d'un modèle pour le message d'un e-mail

Créez un modèle pour le message d'un e-mail contenant un résumé de toutes les alertes déclenchées et résolues, comme dans cet exemple :


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

Pour créer un modèle pour le message d'un e-mail

Créez un modèle de notification appelé email avec deux modèles dans le contenu : email.message_alert etemail.message.

Le email.message_alert modèle est utilisé pour imprimer les étiquettes et les valeurs de chaque alerte déclenchée et résolue, tandis que le email.message modèle contient la structure de l'e-mail.


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

Utilisez le modèle lors de la création de votre intégration de points de contact en le plaçant dans le champ du corps du texte avec le template mot clé.
```
{{ template "email.message" . }}
```

Création d'un modèle pour le titre d'un message Slack

Créez un modèle pour le titre d'un message Slack contenant le nombre d'alertes déclenchées et résolues, comme dans l'exemple suivant :


1 firing alerts, 0 resolved alerts

Pour créer un modèle pour le titre d'un message Slack

Créez un modèle appelé slack.title avec le contenu suivant :


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

Exécutez le modèle à partir du champ de titre dans l'intégration de votre point de contact.
```
{{ template "slack.title" . }}
```

Création d'un modèle pour le contenu d'un message Slack

Créez un modèle pour le contenu d'un message Slack contenant une description de toutes les alertes déclenchées et résolues, y compris leurs étiquettes, leurs annotations et l'URL du tableau de bord.

Note

Ce modèle est réservé aux alertes gérées par Grafana. Pour utiliser le modèle pour les alertes gérées par des sources de données, supprimez les références à DashboardUrl et SilenceURL. Pour plus d'informations sur la configuration des notifications Prometheus, consultez la documentation de Prometheus sur les notifications.


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

Pour créer un modèle pour le contenu d'un message Slack

Créez un modèle appelé slack avec deux modèles dans le contenu : slack.print_alert etslack.message.

Le slack.print_alert modèle est utilisé pour imprimer les étiquettes, les annotations et l'URL du tableau de bord tandis que le slack.message modèle contient la structure de la notification.


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

Exécutez le modèle à partir du champ du corps du texte lors de l'intégration de votre point de contact :
```
{{ template "slack.message" . }}
```

Modélisez à la fois vos e-mails et Slack avec des modèles partagés

Au lieu de créer des modèles de notification distincts pour chaque point de contact, tels que les e-mails et Slack, vous pouvez partager le même modèle.

Par exemple, si vous souhaitez envoyer un e-mail avec cet objet et un message Slack avec ce titre1 firing alerts, 0 resolved alerts, vous pouvez créer un modèle partagé.

Pour créer un modèle partagé

Créez un modèle appelé common.subject_title avec le contenu suivant :


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

Pour les e-mails, exécutez le modèle à partir du champ d'objet de l'intégration de votre point de contact e-mail :
```
{{ template "common.subject_title" . }}
```
Pour Slack, exécutez le modèle à partir du champ de titre dans l'intégration de votre point de contact Slack :
```
{{ template "common.subject_title" . }}
```

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Déployez des modèles

Référence de modèles