Crie modelos de notificação

Este tópico de documentação foi desenvolvido para espaços de trabalho do Grafana que oferecem suporte ao Grafana versão 9.x.

Para espaços de trabalho do Grafana que suportam a versão 10.x do Grafana, consulte. Trabalhando na versão 10 do Grafana

Para espaços de trabalho do Grafana que suportam a versão 8.x do Grafana, consulte. Trabalhando na versão 8 da Grafana

Crie modelos de notificação reutilizáveis para enviar aos seus pontos de contato.

Você pode adicionar um ou mais modelos ao seu modelo de notificação.

O nome do modelo de notificação deve ser exclusivo. Você não pode ter dois modelos com o mesmo nome no mesmo modelo de notificação ou em modelos de notificação diferentes. Evite definir modelos com o mesmo nome dos modelos padrão, como: __subject __text_values_list__text_alert_list,, default.title default.message e.

Na guia Pontos de contato, você pode ver uma lista dos seus modelos de notificação.

Criação de modelos de notificação

Para criar um modelo de notificação

1. Clique em Adicionar modelo.

2. Escolha um nome para o modelo de notificação, comoemail.subject.

3. Escreva o conteúdo do modelo no campo de conteúdo.

   Por exemplo: .

   {{ if .Alerts.Firing -}}
      {{ len .Alerts.Firing }} firing alerts
      {{ end }}
      {{ if .Alerts.Resolved -}}
      {{ len .Alerts.Resolved }} resolved alerts
      {{ end }}

4. Clique em Salvar.

   {{ define "email.subject" }}(onde email.subject está o nome do seu modelo) e {{ end }} é automaticamente adicionado ao início e ao final do conteúdo.

Para criar um modelo de notificação que contenha mais de um modelo:

1. Clique em Adicionar modelo.

2. Insira um nome para o modelo geral de notificação. Por exemplo, email.

3. Escreva cada modelo no campo Conteúdo, incluindo {{ define "name-of-template" }} e {{ end }} no início e no final de cada modelo. Você pode usar nomes descritivos para cada um dos modelos no modelo de notificação, por exemplo, email.subject ouemail.message. Nesse caso, não reutilize o nome do modelo de notificação inserido acima.

   As seções a seguir mostram exemplos detalhados de modelos que você pode criar.

4. Clique em Salvar.

Criação de um modelo para o assunto de um e-mail

Crie um modelo para o assunto de um e-mail que contenha o número de alertas acionados e resolvidos, como neste exemplo:

1 firing alerts, 0 resolved alerts

Para criar um modelo para o assunto de um e-mail

1. Crie um modelo chamado email.subject com o seguinte conteúdo:

   {{ define "email.subject" }}
   {{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
   {{ end }}

2. Use o modelo ao criar sua integração de ponto de contato, colocando-a no campo Assunto com a template palavra-chave.

   {{ template "email.subject" . }}

Criando um modelo para a mensagem de um e-mail

Crie um modelo para a mensagem de um e-mail que contenha um resumo de todos os alertas acionados e resolvidos, como neste exemplo:

There are 2 firing alerts, and 1 resolved alerts

Firing alerts:

- alertname=Test 1 grafana_folder=GrafanaCloud has value(s) B=1
- alertname=Test 2 grafana_folder=GrafanaCloud has value(s) B=2

Resolved alerts:

- alertname=Test 3 grafana_folder=GrafanaCloud has value(s) B=0

Para criar um modelo para a mensagem de um e-mail

1. Crie um modelo de notificação chamado email com dois modelos no conteúdo: email.message_alert email.message e.

   O email.message_alert modelo é usado para imprimir as etiquetas e os valores de cada alerta acionado e resolvido, enquanto o email.message modelo contém a estrutura do e-mail.

   {{- define "email.message_alert" -}}
   {{- range .Labels.SortedPairs }}{{ .Name }}={{ .Value }} {{ end }} has value(s)
   {{- range $k, $v := .Values }} {{ $k }}={{ $v }}{{ end }}
   {{- end -}}
   
   {{ define "email.message" }}
   There are {{ len .Alerts.Firing }} firing alerts, and {{ len .Alerts.Resolved }} resolved alerts
   
   {{ if .Alerts.Firing -}}
   Firing alerts:
   {{- range .Alerts.Firing }}
   - {{ template "email.message_alert" . }}
   {{- end }}
   {{- end }}
   
   {{ if .Alerts.Resolved -}}
   Resolved alerts:
   {{- range .Alerts.Resolved }}
   - {{ template "email.message_alert" . }}
   {{- end }}
   {{- end }}
   
   {{ end }}

2. Use o modelo ao criar sua integração de ponto de contato, colocando-a no campo Corpo do texto com a template palavra-chave.

   {{ template "email.message" . }}

Criação de um modelo para o título de uma mensagem do Slack

Crie um modelo para o título de uma mensagem do Slack que contenha o número de alertas acionados e resolvidos, como no exemplo a seguir:

1 firing alerts, 0 resolved alerts

Para criar um modelo para o título de uma mensagem do Slack

1. Crie um modelo chamado slack.title com o seguinte conteúdo:

   {{ define "slack.title" }}
   {{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
   {{ end }}

2. Use o modelo ao criar sua integração de ponto de contato, colocando-a no campo Título com a template palavra-chave.

   {{ template "slack.title" . }}

Criação de um modelo para o conteúdo de uma mensagem do Slack

Crie um modelo para o conteúdo de uma mensagem do Slack que contenha uma descrição de todos os alertas acionados e resolvidos, incluindo seus rótulos, anotações e URL do painel:

1 firing alerts:

[firing] Test1
Labels:
- alertname: Test1
- grafana_folder: GrafanaCloud
Annotations:
- description: This is a test alert
Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1

1 resolved alerts:

[firing] Test2
Labels:
- alertname: Test2
- grafana_folder: GrafanaCloud
Annotations:
- description: This is another test alert
Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1

Para criar um modelo para o conteúdo de uma mensagem do Slack

1. Crie um modelo chamado slack com dois modelos no conteúdo: slack.print_alert slack.message e.

   O slack.print_alert modelo é usado para imprimir as etiquetas, as anotações e o DashboardURL, enquanto o slack.message modelo contém a estrutura da notificação.

   {{ define "slack.print_alert" -}}
   [{{.Status}}] {{ .Labels.alertname }}
   Labels:
   {{ range .Labels.SortedPairs -}}
   - {{ .Name }}: {{ .Value }}
   {{ end -}}
   {{ if .Annotations -}}
   Annotations:
   {{ range .Annotations.SortedPairs -}}
   - {{ .Name }}: {{ .Value }}
   {{ end -}}
   {{ end -}}
   {{ if .DashboardURL -}}
     Go to dashboard: {{ .DashboardURL }}
   {{- end }}
   {{- end }}
   
   {{ define "slack.message" -}}
   {{ if .Alerts.Firing -}}
   {{ len .Alerts.Firing }} firing alerts:
   {{ range .Alerts.Firing }}
   {{ template "slack.print_alert" . }}
   {{ end -}}
   {{ end }}
   {{ if .Alerts.Resolved -}}
   {{ len .Alerts.Resolved }} resolved alerts:
   {{ range .Alerts.Resolved }}
   {{ template "slack.print_alert" .}}
   {{ end -}}
   {{ end }}
   {{- end }}

2. Use o modelo ao criar sua integração de ponto de contato, colocando-a no campo Corpo do texto com a template palavra-chave.

   {{ template "slack.message" . }}

Crie modelos para e-mail e Slack com modelos compartilhados

Em vez de criar modelos de notificação separados para cada ponto de contato, como e-mail e Slack, você pode compartilhar o mesmo modelo.

Por exemplo, se você quiser enviar um e-mail com esse assunto e uma mensagem do Slack com esse título1 firing alerts, 0 resolved alerts, você pode criar um modelo compartilhado.

Para criar um modelo compartilhado

1. Crie um modelo chamado common.subject_title com o seguinte conteúdo:

   {{ define "common.subject_title" }}
   {{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
   {{ end }}

2. Para e-mail, execute o modelo a partir do campo de assunto na integração do seu ponto de contato de e-mail:

   {{ template "common.subject_title" . }}

3. Para o Slack, execute o modelo a partir do campo de título na integração do seu ponto de contato do Slack:

   {{ template "common.subject_title" . }}

Usando modelos de notificação

Use modelos em pontos de contato para personalizar suas notificações.

Para usar um modelo ao criar um ponto de contato

1. No menu Alertas, escolha Pontos de contato para ver uma lista dos pontos de contato existentes.

2. Escolha Adicionar ponto de contato. Como alternativa, você pode editar um ponto de contato existente escolhendo o ícone Editar (caneta) ao lado do ponto de contato que você deseja editar.

3. Insira os modelos que você deseja usar em um ou mais campos, como Mensagem ou Assunto. Para inserir um modelo, use o formulário{{ template "template_name" . }}, substituindo template_name pelo nome do modelo que você deseja usar.

4. Clique em Salvar ponto de contato.