Modelos de mensagens de notificação

Os modelos de mensagens de notificação permitem que você personalize seus dados de eventos de notificação antes de serem enviados para seu destino de terceiros. Os modelos mapeiam seus valores personalizados para os valores usados pelo seu destino de terceiros.

Isso lhe dá controle total sobre quais dados serão enviados e para onde, além de poder interagir totalmente com os serviços que você usa.

Variáveis de modelo de mensagem

Um modelo de mensagem é o que você usa para converter dados de eventos do New Relic em dados que podem ser consumidos por seu serviço de terceiros. Variáveis são atributos específicos mapeados para campos de dados em seu serviço de terceiros.

Os modelos de mensagens são escritos em uma linguagem de modelos simples chamada Handlebars. As variáveis nos modelos de mensagem são escritas como expressões entre chaves duplas {{ }}.

O menu de variáveis

Os nomes das variáveis do New Relic estão listados no menu de variáveis do modelo de mensagem. As variáveis são agrupadas em subcategorias.

No menu de variáveis, digite {{ para selecionar em uma lista de variáveis. Conforme você digita, os nomes das variáveis aparecem via preenchimento automático. O tipo de variável está escrito no lado direito. Você pode adicionar dados enriquecidos a essas variáveis.

Use a sintaxe do guiador

Quando um evento gera uma notificação, o modelo de mensagem usa as variáveis do Handlebar para mapear os dados da notificação para os campos usados pelo seu serviço de terceiros.

A linguagem Handlebars fornece muitos recursos além da substituição básica de variáveis, incluindo avaliação de objetos e funções de entrada aninhados , como iterações (loops), instruções condicionais e muito mais. No guiador, essas funções são chamadas de auxiliares. Clique aqui para explicação das variáveis utilizadas para fluxo de trabalho.

Funções auxiliares

Nossos modelos de mensagens suportam os auxiliares integrados do Handlebars.

Além disso, adicionamos outros ajudantes que podem ser úteis para você.

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

{{json data.tags}}

["infra", "team-a"]

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

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

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

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

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

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

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

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

The cat likes to eat

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

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

There is no cat to replace

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

The cat likes to eat

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

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

The cat likes to eat

Nossas funções auxiliares também podem ser aninhadas. Aqui está um exemplo:

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

Exemplos de uso

Os exemplos são baseados em uma variável chamada data:

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

O valor data tem um formato equivalente com notação de ponto:

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

Validar dados

Se id for igual 123456789, a saída será valid. Caso contrário, a saída será not valid.

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

Se name for igual Alice, a saída será valid.

Retornar JSON

Obtenha o tags e as propriedades do objeto em um formato JSON:

{{json data.tags}}

Isso retornaria o seguinte JSON:

["infra", "team-a"]

Obtenha valores de uma matriz

Obtenha a primeira tag da matriz tags :

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

Isso retornaria o primeiro valor da matriz:

"infra"

Iterar através de uma matriz

Itere uma variável do tipo matriz e agregue os valores em uma string:

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

O resultado contém a tag, separada por vírgulas (a vírgula final é omitida):

infra, team

Da mesma forma, itere a variável data , agregue os valores do objeto e gere um elemento JSON:

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

Isso retornaria um JSON como:

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

Itere a variável data e agregue as entradas do objeto em uma string:

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

Isso retornaria uma string como:

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

Lidar com atributo ausente

Em alguns casos, como para tags que não estavam presentes nas edições anteriores, um atributo pode estar faltando no menu de variáveis ou não existir.

Podemos usar a instrução #if para definir um substituto, como:

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

Isso retornaria a string "N/A".