Modèles de messages de notification

Les modèles de messages de notification vous permettent de personnaliser les données de votre événement notification avant qu'elles ne soient envoyées à votre destination tierce. Les modèles mappent vos valeurs personnalisées aux valeurs utilisées par votre destination tierce.

Cela vous donne un contrôle total sur les données qui seront envoyées et où, ainsi que la possibilité d'interagir pleinement avec les services que vous utilisez.

Variables du modèle de message

Un modèle de message est ce que vous utilisez pour convertir les données d'événement New Relic en données utilisables par votre service tiers. Les variables sont des attributs spécifiques mappés aux champs de données de votre service tiers.

Les modèles de messages sont écrits dans un langage de création de modèles simple appelé Handlebars. Les variables dans les modèles de message sont écrites sous forme d'expressions entre doubles accolades {{ }}.

A screenshot of an example webhook notification message template.

Utilisez le modèle de message notification pour mapper votre notification New Relic aux champs de vos services externes.

Les noms des variables New Relic sont répertoriés dans le menu des variables du modèle de message. Les variables sont regroupées en sous-catégories.

Dans le menu des variables, tapez {{ pour sélectionner dans une liste de variables. Au fur et à mesure que vous tapez, les noms des variables apparaissent via la saisie semi-automatique. Le type de variable est écrit sur le côté droit. Si le workflow comporte des enrichissements, ils apparaîtront en haut de la liste après avoir tapé {{.

A screenshot of the variables menu that. shows the breadth of variable options available.

Le menu des variables affiche les options dont vous disposez lors de la modélisation New Relic notification des champs sur les champs de votre service externe.

Important

Les variables spécifiques au problème, telles que accumulations.tag.foo n'apparaîtront pas à moins qu'il y ait déjà eu un problème contenant ces métadonnées. Pour créer un modèle de message qui les inclut avant qu'un problème ne survienne, utilisez l'instruction#if décrite ci-dessous.

Utiliser la syntaxe de Handlebars

Lorsqu'un événement génère une notification, le modèle de message utilise les variables de Handlebar pour mapper les données de notification aux champs utilisés par votre service tiers.

Le langage Handlebars fournit de nombreuses fonctionnalités en plus du remplacement de variables de base, notamment l'évaluation d'objets d'entrée et de fonctions imbriqués , tels que les itérations (boucles), les instructions conditionnelles, etc. Dans Handlebars, ces fonctions sont appelées aides. Cliquez ici pour une explication des variables utilisées pour le flux de travail.

Fonctions d'assistance

Nos modèles de messages prennent en charge les assistants intégrés de Handlebars.

De plus, nous avons ajouté d'autres aides qui pourraient vous être utiles.

L'assistant {{json}} convertit le texte en élément JSON.

Utilisez ceci lorsque vous configurez la charge utile d'un Webhook, qui utilise une syntaxe JSON, et toute autre situation dans laquelle vous souhaiterez peut-être transmettre des données au format JSON.

Par exemple, avec une variable appelée data.

{
  "data": {
    "tags": ["infra, team-a"]
  }
}

Pour obtenir l'éventail tags en tant qu'élément JSON, utilisez l'assistant {{json}} :

{{json data.tags}}

obtenir:

["infra", "team-a"]

Similaire à l'assistant {{json}} , l'assistant {{escape}} échappe aux caractères de rupture JSON, mais ne génère pas de sortie JSON.

Utilisez l'assistant d'échappement lorsque la valeur de la variable contient du texte avec des caractères de rupture JSON, tels que ", qui doivent être échappés pour que le modèle de message ait la syntaxe correcte.

Par exemple, les éléments suivants doivent être envoyés sous forme de texte, comme lors de l'envoi à un point de terminaison webhook Slack :

{
  "text": "id:{{ escape issueId }},\nEnrichment Data: {{ escape [latest my_enrichment] }},\nDescription:{{ escape accumulations.conditionDescription }}"
}

Utilisez l’assistant d’égalité {{#eq}} pour comparer les variables.

Compares variables a and b, renders 'yes' or 'no':

{{#eq a b}} yes {{else}} no {{/eq}}

Compares string value "a" to variable b, renders 'yes' or 'no':

{{#eq "a" b}} yes {{else}} no {{/eq}}

Renders 'true' or 'false':

{{eq a b}}

Renders 'y' or 'n':

{{eq a b yes='y' no='n'}}

Utilisez l'assistant {{#contains}} pour comparer les variables.

Asserts that b contains a, renders 'yes' or 'no':

{{#contains a b}} yes {{else}} no {{/contains}}

Asserts that variable b contains string value "a", renders 'yes' or 'no':

{{#contains "a" b}} yes {{else}} no {{/contains}}

Renders 'true' or 'false':

{{contains a b}}

Renders 'y' or 'n':

{{contains a b yes='y' no='n'}}

Utilisez le {{#math}} pour effectuer des opérations mathématiques simples.

Renders addition of two number values:

{{#math openIncidentsCount '+' closedIncidentsCount}} {{/math}}

Renders subtraction of two number values:

{{#math createdAt '-' closedAt}}{{/math}}

Renders multiplication of two number values:

{{#math 3 '*' 3}}{{/math}}

Renders division of two number values:

{{#math 9 '/' 3}}{{/math}}

Utilisez {{#timezone}} pour convertir l'heure d'époque en date au format « aaaa-MM-jj HH:mm:ss zzz ». Vous pouvez trouver une liste des fuseaux horaires de la base de données tz ici.

Exemple n°1 : convertir createdAt dans l'heure d'époque vers le fuseau horaire de l'Est des États-Unis :

{{#timezone createdAt 'US/Eastern'}}{{/timezone}}

obtenir:

"2023-06-06 09:45:07 EDT"

Exemple n°2 : convertir l'heure d'époque en fuseau horaire de Paris :

{{#timezone 1686059107319 'Europe/Paris'}}{{/timezone}}

obtenir:

"2023-06-06 15:45:07 GMT+2"

L'assistant replace remplace l'instance du premier paramètre dans le deuxième paramètre par le bloc enfant.

Utilisez la clause else pour spécifier ce qui se passe lorsqu'aucune instance du premier paramètre n'est trouvée. Si elle est omise, une chaîne vide sera générée.

Exemple n°1 : remplacer le mot dog par cat dans la phrase The dog likes to eat:

{{#replace "dog" "The dog likes to eat"}}cat{{/replace}}

obtenir:

The cat likes to eat

Exemple n°2 : remplacer le mot cat par mouse dans la phrase The dog likes to eat:

{{#replace "cat" "The dog likes to eat"}}mouse{{/replace}}

pour obtenir une chaîne vide :

Exemple n°3 : remplacez le mot cat par mouse dans la phrase The dog likes to eat, en utilisant la clause else :

{{#replace "cat" "The dog likes to eat"}}mouse{{else}}There is no cat to replace{{/replace}}

obtenir:

There is no cat to replace

Exemple n°4 : remplacez le mot dog par cat dans la phrase The DOG likes to eat en ignorant la casse :

{{#replace "/dog/i" "The DOG likes to eat"}}cat{{/replace}}

obtenir:

The cat likes to eat

Exemple n°5 : remplacer la variable {{needle}} par la variable {{replacement}} dans la variable {{haystack}}:

{{#replace needle haystack}}{{replacement}}{{/replace}}

en utilisant ces données :

{
  "needle": "/dog/i",
  "haystack": "The DOG likes to eat",
  "replacement": "cat"
}

obtenir:

The cat likes to eat

Nos fonctions d’aide peuvent également être imbriquées. Voici un exemple :

{{#eq "a" b}} yes1 {{else}}{{#eq "a" c}} yes2 {{else}} no {{/eq}}{{/eq}}

Exemples d'utilisation

Les exemples sont basés sur une variable appelée data:

"data": {
  "tags":["infra, team-a"],
  "id":123456789,
  "name": "Alice",
}

La valeur data a un format équivalent noté par points :

"data.tags": ["infra, team-a"]
"data.id": 123456789
"data.name": "Alice"

Valider les données

Si id est égal à 123456789, alors la sortie est valid. Sinon, la sortie est not valid.

{{eq data.name "Alice" yes='valid' no='not valid'}}

Si name est égal à Alice, alors la sortie est valid.

Renvoyer JSON

Obtenez le tags et les propriétés de l'objet dans un format JSON :

{{json data.tags}}

Cela renverrait le JSON suivant :

["infra", "team-a"]

Obtenir des valeurs à partir d'un éventail

Récupérez la première tag de l'éventail tags :

{{json data.tags.[0]}}

Cela renverrait la première valeur de l'éventail :

"infra"

Parcourir un éventail

Itérer une variable de type éventail et agréger les valeurs dans une chaîne :

{{#each tags}}{{this}}{{#unless @last}}, {{/unless}}{{/each}}

Le résultat contient la balise, séparée par des virgules (la virgule de fin est omise) :

infra, team

De même, parcourez la variable data , agrégez les valeurs de l'objet et générez un élément JSON :

{{#each (json data)}}{{this}}{{/each}}

Cela renverrait un JSON tel que :

{
  "tags": ["infra, team-a"],
  "name": "Alice",
  "id": "123456789"
}

Itérez la variable data , puis agrégez les entrées de l'objet dans une chaîne :

{{#each data}}{{@key}}: {{this}}{{#unless @last}}, {{/unless}}{{/each}}

Cela renverrait une chaîne telle que :

tags: infra,team-a, name: Alice, id: 123456789

Gérer l'attribut manquant

Dans certains cas, comme pour les balises qui n'étaient pas présentes dans les numéros précédents, un attribut peut être manquant dans le menu des variables ou ne pas exister du tout.

Nous pouvons utiliser l'instruction #if pour définir une solution de secours, telle que :

{{#if data.type}}{{ json data.type }}{{else}}"N/A"{{/if}}

Cela renverrait la chaîne "N/A".

Prudence

Si un attribut manquant possède également une valeur imbriquée, le rendu échouera, nous n'enregistrerons donc pas la charge utile du webhook. Par exemple, le cas :

{{#if data.type}}{{ json data.type }}{{else}}"N/A"{{/if}}

devra être modifié en :

{{#if data}}{{#if data.type}}{{ json data.type }}{{else}}"N/A"{{else}}"N/A"{{/if}}

Cette traduction automatique est fournie pour votre commodité.

Variables du modèle de message

Le menu des variables

Important

Utiliser la syntaxe de Handlebars

Fonctions d'assistance

JSON

S'échapper

Égalité

Contient

Mathématiques

Fuseau horaire

Remplacer

Exemples d'utilisation

Valider les données

Renvoyer JSON

Obtenir des valeurs à partir d'un éventail

Parcourir un éventail

Gérer l'attribut manquant

Prudence

Cette traduction automatique est fournie pour votre commodité.

Modèles de messages de notification

Variables du modèle de message .css-21sua1{background:none;border:none;width:0;padding:0;}

Le menu des variables

Important

Utiliser la syntaxe de Handlebars

Fonctions d'assistance

S'échapper

Égalité

Contient

Mathématiques

Fuseau horaire

Remplacer

Exemples d'utilisation

Valider les données

Renvoyer JSON

Obtenir des valeurs à partir d'un éventail

Parcourir un éventail

Gérer l'attribut manquant

Prudence

Variables du modèle de message