Référence de modèles

Cette rubrique de documentation est conçue pour les espaces de travail Grafana compatibles avec la version 9.x de Grafana.

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

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

Cette section fournit des informations de référence pour créer vos modèles.

Données du modèle

Les données suivantes sont transmises aux modèles de messages.

Nom	Type	Remarques
Receiver	chaîne	Nom du point de contact auquel la notification est envoyée.
Status	chaîne	déclenchement si au moins une alerte est déclenchée, sinon résolu.
Alerts	Alerte	Liste des objets d'alerte inclus dans cette notification (voir ci-dessous).
GroupLabels	KeyValue	Libellés selon lesquels ces alertes ont été regroupées.
CommonLabels	KeyValue	Libellés communs à toutes les alertes incluses dans cette notification.
CommonAnnotations	KeyValue	Annotations communes à toutes les alertes incluses dans cette notification.
ExternalURL	chaîne	Lien de retour vers le Grafana qui a envoyé la notification. Si vous utilisez un Alertmanager externe, renvoyez le lien vers ce Alertmanager.

Le Alerts type expose deux fonctions permettant de filtrer les alertes renvoyées.

• Alerts.Firing— Renvoie la liste des alertes de déclenchement.

• Alerts.Resolved— Renvoie la liste des alertes résolues.

Alerte (type)

Le type d'alerte contient les données suivantes.

Nom	Type	Remarques
Statut	chaîne	firing ou resolved.
Étiquettes	KeyValue	Ensemble d'étiquettes associées à l'alerte.
Annotations	KeyValue	Ensemble d'annotations associées à l'alerte.
Valeurs	KeyValue	Les valeurs de toutes les expressions, y compris les conditions classiques
StartsAt	Heure. Heure	Heure à laquelle l'alerte a commencé à se déclencher.
EndsAt	Heure. Heure	Paramétré uniquement si l'heure de fin d'une alerte est connue. Sinon, définissez un délai d'expiration configurable à compter de la date de réception de la dernière alerte.
URL du générateur	chaîne	Un lien de retour vers Grafana ou un Alertmanager externe.
URL de silence	chaîne	Un lien pour désactiver l'alerte (avec des étiquettes préremplies pour cette alerte). Uniquement pour les alertes gérées par Grafana.
URL du tableau de bord	chaîne	Lien vers le tableau de bord de Grafana, si la règle d'alerte appartient à l'une d'entre elles. Uniquement pour les alertes gérées par Grafana.
URL du panneau	chaîne	Lien vers le panneau du tableau de bord de Grafana, si la règle d'alerte appartient à l'une d'entre elles. Uniquement pour les alertes gérées par Grafana.
Empreinte digitale	chaîne	Empreinte digitale qui peut être utilisée pour identifier l'alerte.
ValueString	chaîne	Chaîne contenant les libellés et la valeur de chaque expression réduite de l'alerte.

ExtendedData

L' ExtendedData objet contient les propriétés suivantes.

Nom	Kind	Description	Exemple
Récepteur	string	Nom du point de contact qui envoie la notification.	{{ .Receiver }}
Statut	string	Le statut est firing if at least one alert is firing, otherwise resolved.	{{ .Status }}
Alerts (Alertes)	[]Alert	Liste de toutes les alertes déclenchées et résolues dans cette notification.	There are {{ len .Alerts }} alerts
Alertes de tir	[]Alert	Liste de toutes les alertes de tir contenues dans cette notification.	There are {{ len .Alerts.Firing }} firing alerts
Alertes résolues	[]Alert	Liste de toutes les alertes résolues dans cette notification.	There are {{ len .Alerts.Resolved }} resolved alerts
GroupLabels	KeyValue	Les étiquettes qui regroupent ces alertes dans cette notification.	{{ .GroupLabels }}
CommonLabels	KeyValue	Les libellés communs à toutes les alertes de cette notification.	{{ .CommonLabels }}
CommonAnnotations	KeyValue	Les annotations communes à toutes les alertes de cette notification.	{{ .CommonAnnotations }}
URL externe	string	Un lien vers l'espace de travail Grafana ou Alertmanager qui a envoyé cette notification.	{{ .ExternalURL }}

KeyValue type

Le KeyValue type est un ensemble de paires de chaînes clé/valeur qui représentent des étiquettes et des annotations.

Outre l'accès direct aux données stockées sous forme de fichierKeyValue, il existe également des méthodes de tri, de suppression et de transformation des données.

Nom	Arguments	Renvoie	Remarques	Exemple
SortedPairs		Liste triée des paires de chaînes de clés et de valeurs		{{ .Annotations.SortedPairs }}
Remove (suppression)	[] chaîne	KeyValue	Renvoie une copie de la carte clé/valeur sans les clés données.	{{ .Annotations.Remove "summary" }}
Noms		[] chaîne	Liste des noms d'étiquettes	{{ .Names }}
Valeurs		[] chaîne	Liste des valeurs d'étiquette	{{ .Values }}

Time (Période)

L'heure est comptée dans le timepackage Go. Vous pouvez imprimer une heure dans différents formats. Par exemple, pour imprimer l'heure à laquelle une alerte s'est déclenchée dans ce formatMonday, 1st January 2022 at 10:00AM, vous devez écrire le modèle suivant :

{{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }}

Vous pouvez trouver une référence pour le format horaire de Go ici.

Fonctions du modèle

À l'aide des fonctions du modèle, vous pouvez traiter les étiquettes et les annotations pour générer des notifications dynamiques. Les fonctions suivantes sont disponibles.

Nom	Type d'argument	Type de retour	Description
humanize	nombre ou chaîne	chaîne	Convertit un nombre dans un format plus lisible à l'aide de préfixes métriques.
humanize1024	nombre ou chaîne	chaîne	Comme humanize, mais utilise 1024 comme base au lieu de 1000.
humanizeDuration	nombre ou chaîne	chaîne	Convertit une durée en secondes dans un format plus lisible.
humanizePercentage	nombre ou chaîne	chaîne	Convertit une valeur de ratio en une fraction de 100.
humanizeTimestamp	nombre ou chaîne	chaîne	Convertit un horodatage Unix en secondes dans un format plus lisible.
title	chaîne	chaîne	Strings.title, met en majuscule le premier caractère de chaque mot.
toUpper	chaîne	chaîne	cordes. ToUpper, convertit tous les caractères en majuscules.
toLower	chaîne	chaîne	cordes. ToLower, convertit tous les caractères en minuscules.
match	motif, texte	Booléen	expression régulière. MatchString Teste une correspondance regexp non ancrée.
reReplaceAll	modèle, remplacement, texte	chaîne	Expression régulière. ReplaceAllString Substitution de Regexp, non ancrée.
graphLink	string - Objet JSON avec datasource champs expr et	chaîne	Renvoie le chemin d'accès à la vue graphique dans Explore pour l'expression et la source de données données.
tableLink	string - Objet JSON avec datasource champs expr et	chaîne	Renvoie le chemin d'accès à la vue tabulaire dans Explore pour l'expression et la source de données données.
args	[] interface {}	carte [chaîne] interface {}	Convertit une liste d'objets en carte avec des clés, par exemple arg0, arg1. Utilisez cette fonction pour transmettre plusieurs arguments aux modèles.
externalURL	rien	chaîne	Renvoie une chaîne représentant l'URL externe.
pathPrefix	rien	chaîne	Renvoie le chemin de l'URL externe.

Le tableau suivant présente des exemples d'utilisation de chaque fonction.

Fonction	TemplateString	Entrée	Expected
humaniser	{humaniser $value}	1234567,0	1,235 M
humaniser 1024	{humaniser 1024$ de valeur}	1048576,0	1 mi
Humaniser la durée	{HumanizeDuration $value}	899,99	14 m 59 s
Pourcentage d'humanisation	{humanizePercentage $value}	0,1234567	12,35 %
Humaniser l'horodatage	{humanizeTimestamp $value}	1435065584,128	23/06/2015 13:19:44,128 +0000 UTC
title	{$value | titre}	un B C	Aa Bb CC
toUpper	{$value | toUpper}	un B C	AA BB CC
toLower	{$value | toLower}	un B C	AA BB CC
match	{correspond à « a+ » $labels.instance}	aa	true
reReplaceAll	{{ reReplaceAll « localhost :( .*) » « my.domain : $1 » $labels.instance}}	hôte local : 3000	mon domaine .domain : 3000
GraphLink	{{GraphLink « {\" expr \ » : \ "up \ », \ "source de données \ » : \ "gdev-prometheus \"} »}		/explorer ? left= ["now-1h », « now », « gdev-prometheus », {"source de données » « gdev-prometheus », « expr » « up », « instant » :false, "range » :true}]
Tableau Link	{{TableLink « {\" expr \ » : \ "up \ », \ "source de données \ » : \ "gdev-prometheus \"} »}		/explorer ? left= ["now-1h », « now », « gdev-prometheus », {"source de données » « gdev-prometheus », « expr » « up », « instant » :true, "range » :false}]
args	{{define « x »}} {{.arg0}} {{.arg1}} {{end}} {{modèle « x » (args 1 « 2 »)}}		1 2
URL externe	{URL externe}		http://localhost/path/prefix
Préfixe de chemin	{PathPrefix}		/chemin/préfixe