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

A screenshot of an example webhook notification message template.

Use o modelo de mensagem de notificação para mapear suas notificações do New Relic para os campos em seus serviços externos.

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. Se o fluxo de trabalho tiver enriquecimentos, eles aparecerão no topo da lista após digitar {{.

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

O menu de variáveis mostra as opções que você tem ao mapear campos de notificação do New Relic nos campos do seu serviço externo.

Importante

Variáveis específicas do problema, como accumulations.tag.foo não aparecerão a menos que já tenha havido um problema contendo esses metadados. Para criar um modelo de mensagem que os inclua antes que um problema ocorra, use a instrução#if descrita abaixo.

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ê.

O auxiliar {{json}} converte texto em um elemento JSON.

Use isso ao configurar a carga útil de um Webhook, que usa uma sintaxe JSON, e em qualquer outra situação em que você queira passar dados formatados em JSON.

Por exemplo, com uma variável chamada data.

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

Para obter a matriz tags como um elemento JSON, use o auxiliar {{json}} :

{{json data.tags}}

obter:

["infra", "team-a"]

Semelhante ao auxiliar {{json}} , o auxiliar {{escape}} escapa dos caracteres de quebra de JSON, mas não gera saída JSON.

Use o auxiliar de escape quando o valor da variável contiver texto com caracteres de quebra de JSON, como ", que deve ser escapado para que o modelo de mensagem tenha a sintaxe correta.

Por exemplo, o seguinte precisa ser enviado como texto, como ao enviar para um endpoint de webhook do Slack:

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

Use o auxiliar de igualdade {{#eq}} para comparar variáveis.

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

Use o auxiliar {{#contains}} para comparar variáveis.

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

Use o {{#math}} para realizar operações matemáticas 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}}

Use {{#timezone}} para converter a epoch em uma data no formato 'aaaa-MM-dd HH:mm:ss zzz'. Você pode encontrar uma lista de fusos horários do banco de dados tz aqui.

Exemplo # 1: converter createAt no horário da epoch para o fuso horário do Leste dos EUA:

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

obter:

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

Exemplo # 2: converter a hora da epoch para o fuso horário de Paris::

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

obter:

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

O auxiliar replace substitui a instância do primeiro parâmetro no segundo parâmetro pelo bloco filho.

Use a cláusula else para especificar o que acontece quando nenhuma instância do primeiro parâmetro é encontrada. Se for omitido, será gerada uma string vazia.

Exemplo #1: substitua a palavra dog por cat na frase The dog likes to eat:

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

obter:

The cat likes to eat

Exemplo #2: substitua a palavra cat por mouse na frase The dog likes to eat:

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

para obter uma string vazia:

Exemplo #3: substitua a palavra cat por mouse na frase The dog likes to eat, usando a cláusula else :

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

obter:

There is no cat to replace

Exemplo #4: substitua a palavra dog por cat na frase The DOG likes to eat ignorando maiúsculas e minúsculas:

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

obter:

The cat likes to eat

Exemplo #5: substitua a variável {{needle}} pela variável {{replacement}} na variável {{haystack}}:

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

usando estes dados:

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

obter:

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".

Esta tradução de máquina é fornecida para sua comodidade.

Variáveis de modelo de mensagem

O menu de variáveis

Importante

Use a sintaxe do guiador

Funções auxiliares

JSON

Escapar

Igualdade

Contém

Matemática

Fuso horário

Substituir

Exemplos de uso

Validar dados

Retornar JSON

Obtenha valores de uma matriz

Iterar através de uma matriz

Lidar com atributo ausente

Esta tradução de máquina é fornecida para sua comodidade.

Modelos de mensagens de notificação

Variáveis de modelo de mensagem .css-21sua1{background:none;border:none;width:0;padding:0;}

O menu de variáveis

Importante

Use a sintaxe do guiador

Funções auxiliares

Escapar

Igualdade

Contém

Matemática

Fuso horário

Substituir

Exemplos de uso

Validar dados

Retornar JSON

Obtenha valores de uma matriz

Iterar através de uma matriz

Lidar com atributo ausente

Variáveis de modelo de mensagem