Utilisez des variables dans les messages de notification pour afficher des messages conditionnels et acheminer les notifications vers différentes équipes en utilisant des variables conditionnelles, ou pour enrichir leur contenu en utilisant des variables d’attribut et de tag et des variables de modèle.

Variables conditionnelles

Les variables conditionnelles utilisent if-else la logique pour afficher un message différent en fonction de l’état du moniteur et des détails de son déclenchement. Ces variables peuvent être utilisées dans le sujet ou le corps du message de notification.

Voici la liste des variables conditionnelles disponibles :

Exemples

Les variables conditionnelles doivent avoir une paire d’ouverture et de fermeture avec le texte et @-notifications entre les deux. Les variables basées sur l’état du moniteur (comme is_alert ou is_warning), doivent avoir leur propre bloc de message. Parce qu’un moniteur ne peut être dans qu’un seul état à la fois, vous ne pouvez pas les combiner. Cependant, vous pouvez imbriquer des conditionnels qui correspondent aux attributs, voir les is_renotify exemples.

{{#is_alert}}
  <ALERT_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_alert}}

{{#is_warning}}
  <WARNING_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_warning}}

{{#is_recovery}}
  <RECOVERY_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_recovery}}

{{#is_match "<TAG_VARIABLE>.name" "<COMPARISON_STRING>"}}
  This displays if <COMPARISON_STRING> is included in <TAG_VARIABLE>.
{{/is_match}}

{{#is_match "host.role.name" "db"}}
  This displays if the host triggering the alert contains `db`
  in the role name. @db-team@company.com
{{/is_match}}

{{#is_match "host.role.name" "db" "database"}}
  This displays if the host triggering the alert contains `db` or `database`
  in the role name. @db-team@company.com
{{/is_match}}

{{^is_match "host.role.name" "db"}}
  This displays if the role tag doesn't contain `db`.
  @slack-example
{{/is_match}}

{{#is_match "host.role.name" "db"}}
  This displays if the host triggering the alert contains `db`
  in the role name. @db-team@company.com
{{else}}
  This displays if the role tag doesn't contain `db`.
  @slack-example
{{/is_match}}

{{#is_exact_match "<TAG_VARIABLE>.name" "<COMPARISON_STRING>"}}
  This displays if <COMPARISON_STRING> is exactly <TAG_VARIABLE>.
{{/is_exact_match}}

{{#is_exact_match "host.name" "production"}}
  This displays if the host that triggered the alert is exactly
  named production. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "host.name" "production" "staging"}}
  This displays if the host that triggered the alert is exactly
  named production or staging. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "value" "<VALUE>"}}
  This displays if the value that breached the threshold of the monitor is exactly <VALUE>.
{{/is_exact_match}}

{{#is_exact_match "value" "5"}}
  This displays if the value that breached the threshold of the monitor is 5. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "host.datacenter" ""}}
  This displays if the attribute or tag does not exist or if it's empty
{{/is_exact_match}}

{{#is_renotify}}
{{#is_match "env" "production"}}
  This is an escalation message sent to @dev-team@company.com
{{/is_match}}
{{/is_renotify}}

{{^is_renotify}}
This monitor is alerting and sending a first message @dev-team@company.com

To solve this monitor follow the steps:
1. Go there
2. Do this
{{/is_renotify}}

This part is generic and sent both for the first trigger and the escalation message.

{{#is_renotify}}
  This is the escalation message @dev-team@company.com
{{/is_renotify}}

This part is generic and sent both for the first trigger and the escalation message.

This is the escalation message @dev-team@company.com

Si vous configurez un bloc conditionnel pour une transition d’état dans les conditions alert ou warning avec un gestionnaire de notifications @-notifications, Datadog recommande de configurer une condition recovery correspondante pour envoyer une notification de récupération au gestionnaire.

Remarque: Tout texte ou gestionnaire de notification placé en dehors des variables conditionnelles configurées est invoqué à chaque transition d’état du moniteur. Tout texte ou gestionnaire de notification placé à l’intérieur des variables conditionnelles configurées n’est invoqué que si la transition d’état du moniteur correspond à sa condition.

Variables d’attribut et de tag

Utilisez des variables d’attribut et de tag pour rendre les messages d’alerte personnalisés, informatifs et spécifiques afin d’aider à comprendre la nature de l’alerte. Voir les sections suivantes pour des exemples et des cas d’utilisation :

• Variables d’alerte multiples
• Variables d’attribut/tag correspondantes

Les tags

Attaché automatiquement (comme le nom d’hôte, le nom de conteneur, le nom de fichier journal et le nom de fonction sans serveur) ou ajouté par le biais de tags personnalisés (comme l’équipe responsable, l’environnement, l’application ou la version).

Attributes

Basé sur le contenu du journal et soit analysé soit ajouté par des recherches dans des tables de référence (par exemple, geoip).

Remarque : Si le moniteur est configuré pour se rétablir dans des conditions sans données (par exemple, lorsqu’il n’y a aucun événement correspondant à la requête), le message de récupération ne contient aucune donnée. Pour persister des informations dans le message de récupération, regroupez par des tags supplémentaires, qui sont accessibles par {{tag.name}}.

Variables d’alerte multiples

Configurez des variables d’alerte multiples dans les moniteurs d’alerte multiples en fonction de la dimension sélectionnée dans la boîte de groupe d’alerte multiples. Enrichissez les notifications en incluant dynamiquement la valeur associée à la dimension de regroupement dans chaque alerte.

Remarque : Lorsque vous utilisez le champ group_by dans l’agrégation, des tags et alertes supplémentaires du moniteur peuvent être hérités automatiquement. Cela signifie que toutes les alertes ou configurations définies sur le point de terminaison surveillé pourraient être appliquées à chaque groupe résultant de l’agrégation.

{{ key.name }}

{{[dot.key.test].name}}

{{ @facet_key.name }}

This alert was triggered on {{ @machine_id.name }}

{{ [@network.client.ip].name }}

Personnalisez la notification en fonction du groupe

Lorsque votre requête est regroupée par des dimensions spécifiques, vous pouvez enrichir les notifications avec des métadonnées dynamiques associées au groupe. Pour voir une liste de variables de tag en fonction de votre sélection de tags, cliquez sur Utiliser des variables de modèle de message dans la section Configurer les notifications et les automatisations. Voir les exemples suivants :

{{service.links[Runbook]}}

Correspondance des variables d’attribut/tag

Vous pouvez inclure tout attribut ou tag d’un journal, d’une trace, d’un événement RUM, d’un pipeline CI ou d’un événement de test CI qui correspond à la requête de surveillance. Le tableau suivant montre des exemples d’attributs et de variables que vous pouvez ajouter à partir de différents types de surveillance.

Notes importantes

• Si l’événement sélectionné n’inclut pas l’attribut ou la clé de balise, la variable rend vide dans le message de notification. Pour éviter de manquer des notifications, évitez d’utiliser ces variables pour le routage des notifications avec {{#is_match}} gère.
• Pour les moniteurs utilisant des Formules et Fonctions dans les requêtes, les valeurs se résolvent en fonction des événements extraits de la première requête.

Attributs réservés

Les événements de logs, de gestion des événements, de spans, de RUM, de Pipeline CI et de tests CI disposent d’attributs réservés génériques, que vous pouvez utiliser dans les variables avec la syntaxe suivante :

Si l’événement correspondant ne contient pas l’attribut dans sa définition, la variable n’affiche rien.

Lien de l’explorateur

Utilisez {{log.link}}, {{span.link}}, {{rum.link}}, and {{issue.link}} pour enrichir la notification avec un lien vers l’Explorateur de Logs, l’Explorateur de Traces, l’Explorateur RUM ou le Suivi des Erreurs, en se basant sur les événements correspondant à la requête.

Vérifiez les variables de surveillance

Pour vérifier les variables de surveillance (vérification personnalisée et vérification d’intégration), la variable {{check_message}} est disponible et rend le message spécifié dans la vérification personnalisée ou la vérification d’intégration.

Variables de surveillance composites

Les monitors composite peuvent accéder à la valeur et à l’état associés aux sous-monitors au moment du déclenchement de l’alarme.

Par exemple, si votre moniteur composite a un sous-moniteur a, vous pouvez inclure la valeur de a avec :

{{ a.value }}

Pour récupérer le statut du sous-moniteur a, utilisez :

{{ a.status }}

Les valeurs possibles pour le statut sont : OK, Alert, Warn et No Data.

Les moniteurs composites prennent également en charge les variables de tag de la même manière que leurs moniteurs sous-jacents. Ils suivent le même format que les autres moniteurs, à condition que les moniteurs sous-jacents soient regroupés par le même tag ou facette.

Par exemple, supposons que votre moniteur composite ait un sous-moniteur a, qui est un moniteur de journaux. Vous pouvez inclure la valeur de n’importe quel tag ou facette de a avec :

{{ a.log.message }} or {{ a.log.my_facet }}

Échappement de caractères

Le contenu variable est encodé en HTML par défaut. Pour afficher du contenu brut, non encodé, utilisez trois accolades au lieu de deux.

Par exemple, lorsque la valeur d’une variable contient une URL avec des paramètres de requête, le & est traité différemment selon que des doubles ou des triples accolades sont utilisées :

Par exemple, pour rendre le message de vérification sans encodage HTML :

{{{check_message}}}

Ceci est particulièrement pertinent lorsque {{check_message}} contains auto-generated URLs with query parameters (for example, on HTTP Check monitors). The & characters in those URLs are HTML-encoded by default, which can break clickable links in notifications. Use {{{check_message}}} pour préserver les URLs telles quelles.

Variables de modèle

Utilisez des variables de template pour personnaliser vos notifications de monitor. Les variables intégrées sont :

Variables déclenchées

Le {{first_triggered_at}}, {{first_triggered_at_epoch}}, {{last_triggered_at}}, and {{last_triggered_at_epoch}} monitor template variables reflect the values when a monitor changes state, NOT when a new monitor event occurs. Renotification events show the same template variable if the monitor state has not changed. Use {{triggered_duration_sec}} pour afficher la durée au moment de l’événement du moniteur.

{{first_triggered_at}} is set when the monitor group goes from OK to a non-OK state or when a new group appears in a non-OK state. {{last_triggered_at}} gets set when the monitor group goes to a non-OK state independently from its previous state (including WARN → ALERT, ALERT → WARN). Additionally, {{last_triggered_at}} is set when a new group appears in a non-OK state. The difference is that {{last_triggered_at}} est indépendant de son état précédent.

Exemple : Lorsque le moniteur passe de OK → WARN, les valeurs de {{first_triggered_at}} and {{last_triggered_at}} ont tous deux l’horodatage A. Le tableau ci-dessous montre les valeurs jusqu’à ce que le moniteur se rétablisse.

Évaluation

Les variables de modèle qui renvoient des valeurs numériques prennent en charge des opérations et des fonctions, ce qui vous permet d’effectuer des opérations mathématiques ou des modifications de format sur la valeur. Pour plus de détails, voir Évaluation des variables de modèle.

Heure locale

Utilisez la fonction local_time pour ajouter une autre date dans votre notification dans le fuseau horaire de votre choix. Cette fonction transforme une date en son heure locale : {{local_time 'time_variable' 'timezone'}}. Par exemple, pour ajouter l’heure du dernier déclenchement du moniteur dans le fuseau horaire de Tokyo dans votre notification, incluez ce qui suit dans le message de notification :

{{local_time 'last_triggered_at' 'Asia/Tokyo'}}

Le résultat est affiché au format ISO 8601 : yyyy-MM-dd HH:mm:ss±HH:mm, par exemple 2021-05-31 23:43:27+09:00. Consultez la liste des fuseaux horaires de la base de données tz, en particulier la colonne des noms de la base de données TZ, pour voir la liste des valeurs de fuseau horaire disponibles.

Avancé

Gestionnaires dynamiques

Utilisez les variables de balise pour construire dynamiquement des gestionnaires de notification et acheminer les notifications vers la bonne équipe ou service en fonction du type de problème détecté par votre moniteur.

Exemple : Si votre moniteur interroge une métrique et la regroupe par une service balise, vous pouvez faire en sorte que vos notifications soient acheminées vers différents canaux Slack en fonction du service défaillant :

@slack-{{service.name}} There is an ongoing issue with {{service.name}}.

Si votre moniteur commence à échouer sur le groupe service:ad-server, la notification est envoyée au canal Slack #ad-server avec le contenu suivant :

@slack-ad-server There is an ongoing issue with ad-server.

Lors de la création de gestionnaires dynamiques avec des attributs qui pourraient ne pas toujours être présents, vous pourriez rencontrer des problèmes de livraison de notification. Si un attribut est manquant, la variable apparaît vide dans le message de notification, ce qui entraîne un gestionnaire invalide.

Pour éviter les notifications manquées avec ces variables, pensez à ajouter un handle de secours :

{{#is_exact_match "kube_namespace.owner" ""}}
  @slack-example
  // This will notify @slack-example if the kube_namespace.owner variable is empty or does not exist.
{{/is_exact_match}}

Liens dynamiques

Utilisez les variables de balise pour activer la création dynamique d’URL qui relie votre équipe à une ressource appropriée. Par exemple, vous pouvez fournir des liens vers des pages au sein de Datadog telles que des tableaux de bord, la carte des hôtes et des moniteurs.

https://app.datadoghq.com/dash/integration/system_overview?tpl_var_scope=host:{{host.name}}

https://app.datadoghq.com/dash/integration/<INTEGRATION_NAME>?tpl_var_scope=host:{{host.name}}

https://app.datadoghq.com/dashboard/<DASHBOARD_ID>/<DASHBOARD_NAME>?from_ts={{eval "last_triggered_at_epoch-10*60*1000"}}&to_ts={{eval "last_triggered_at_epoch+10*60*1000"}}&live=false

https://app.datadoghq.com/infrastructure/map?filter=service:{{service.name}}

https://app.datadoghq.com/monitors/manage?q=scope:host:{{host.name}}

https://app.datadoghq.com/logs?from_ts={{eval "last_triggered_at_epoch-10*60*1000"}}&to_ts={{eval "last_triggered_at_epoch+10*60*1000"}}&live=false

Commentaires

Pour ajouter un commentaire dans le message du monitor, utilisez la syntaxe suivante :

{{!-- this is a comment --}}
{{!-- this is a comment }}

Format brut

Si votre message d’alerte doit envoyer des accolades doubles, comme {{ <TEXT> }}, use {{{{raw}}}} formatage. Par exemple, ce qui suit :

{{{{raw}}}}
{{ <TEXT_1> }} {{ <TEXT_2> }}
{{{{/raw}}}}

Résultat :

{{ <TEXT_1> }} {{ <TEXT_2> }}

Les ^|# aides utilisées dans les variables conditionnelles ne peuvent pas être utilisées avec {{{{raw}}}} formatting and must be removed. For instance, to output raw text with the La variable conditionnelle {{is_match}}` utilise le modèle suivant :

{{{{is_match "host.name" "<HOST_NAME>"}}}}
{{ .matched }} the host name
{{{{/is_match}}}}

Si host.name correspond à <HOST_NAME>, le modèle produit :

{{ .matched }} the host name

Encoder l’URL

Si votre message d’alerte contient des informations qui doivent être encodées dans une URL (par exemple, pour des redirections), utilisez le {{ urlencode "<variable>"}} syntaxe.

Exemple : Si votre message de surveillance contient une URL vers le Catalogue de Logiciels filtrée pour un service spécifique, utilisez la service variable de balise et ajoutez le {{ urlencode "<variable>"}} syntaxe à l’URL :

https://app.datadoghq.com/services/{{urlencode "service.name"}}

Lectures complémentaires

Documentation, liens et articles supplémentaires utiles:

Effectuer des opérations arithmétiques et des fonctions avec des évaluations de variables de modèleGUIDE Créer des monitorsDOCUMENTATION Notifications des monitorsDOCUMENTATION Gérer les monitorsDOCUMENTATION Suivez une formation pour apprendre à personnaliser les notifications de vos monitors d'alerte.CENTRE D'APPRENTISSAGE Dirigez vos alertes de monitor avec les règles de notification des monitors DatadogBLOG