Crear plantillas de notificaciones - Amazon Managed Grafana
Crear plantillas de notificacionesCrear una plantilla para el asunto de un correo electrónicoCrear una plantilla para el mensaje de un correo electrónicoCrear una plantilla para el título de un mensaje de SlackCrear una plantilla para el contenido de un mensaje de SlackCrea plantillas para correo electrónico y Slack con plantillas compartidasUsa plantillas de notificaciones

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Crear plantillas de notificaciones

Este tema de documentación está diseñado para los espacios de trabajo de Grafana que admiten la versión 9.x de Grafana.

Para ver los espacios de trabajo de Grafana que admiten la versión 10.x de Grafana, consulte. Trabajando en Grafana versión 10

Para ver los espacios de trabajo de Grafana que admiten la versión 8.x de Grafana, consulte. Trabajando en Grafana versión 8

Cree plantillas de notificaciones reutilizables para enviarlas a sus puntos de contacto.

Puedes añadir una o más plantillas a tu plantilla de notificaciones.

El nombre de la plantilla de notificaciones debe ser único. No puede tener dos plantillas con el mismo nombre en la misma plantilla de notificación o en plantillas de notificación diferentes. Evite definir plantillas con el mismo nombre que las plantillas predeterminadas, como: __subject__text_values_list,__text_alert_list, default.title ydefault.message.

En la pestaña Puntos de contacto, puedes ver una lista de tus plantillas de notificaciones.

Crear plantillas de notificaciones

Para crear una plantilla de notificaciones

  1. Haz clic en Añadir plantilla.

  2. Elija un nombre para la plantilla de notificaciones, comoemail.subject.

  3. Escribe el contenido de la plantilla en el campo de contenido.

    Por ejemplo:

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

  4. Haga clic en Guardar.

    {{ define "email.subject" }}(donde email.subject está el nombre de la plantilla) y {{ end }} se añade automáticamente al principio y al final del contenido.

Para crear una plantilla de notificaciones que contenga más de una plantilla:

  1. Haz clic en Añadir plantilla.

  2. Introduzca un nombre para la plantilla de notificación general. Por ejemplo, email.

  3. Escribe cada plantilla en el campo Contenido, incluyendo {{ define "name-of-template" }} y {{ end }} al principio y al final de cada plantilla. Puede utilizar nombres descriptivos para cada una de las plantillas de la plantilla de notificaciones, por ejemplo, email.subject oemail.message. En este caso, no vuelva a utilizar el nombre de la plantilla de notificaciones que ha introducido anteriormente.

    En las siguientes secciones se muestran ejemplos detallados de las plantillas que puede crear.

  4. Haga clic en Guardar.

Crear una plantilla para el asunto de un correo electrónico

Crea una plantilla para el asunto de un correo electrónico que contenga el número de alertas activadas y resueltas, como en este ejemplo:

1 firing alerts, 0 resolved alerts
Para crear una plantilla para el asunto de un correo electrónico

  1. Cree una plantilla llamada email.subject con el siguiente contenido:

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

  2. Use la plantilla al crear la integración de su punto de contacto colocándola en el campo Asunto con la template palabra clave.

    {{ template "email.subject" . }}

Crear una plantilla para el mensaje de un correo electrónico

Cree una plantilla para el mensaje de un correo electrónico que contenga un resumen de todas las alertas activadas y resueltas, como en este ejemplo:

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 crear una plantilla para el mensaje de un correo electrónico

  1. Cree una plantilla de notificaciones llamada email con dos plantillas en el contenido: email.message_alert yemail.message.

    La email.message_alert plantilla se utiliza para imprimir las etiquetas y los valores de cada alerta activada y resuelta, mientras que la email.message plantilla contiene la estructura del correo electrónico.

    {{- 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. Usa la plantilla al crear la integración de tu punto de contacto colocándola en el campo del cuerpo del texto con la template palabra clave.

    {{ template "email.message" . }}

Crear una plantilla para el título de un mensaje de Slack

Crea una plantilla para el título de un mensaje de Slack que contenga el número de alertas activadas y resueltas, como en el siguiente ejemplo:

1 firing alerts, 0 resolved alerts
Para crear una plantilla para el título de un mensaje de Slack

  1. Crea una plantilla llamada slack.title con el siguiente contenido:

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

  2. Use la plantilla al crear la integración de su punto de contacto colocándola en el campo Título con la template palabra clave.

    {{ template "slack.title" . }}

Crear una plantilla para el contenido de un mensaje de Slack

Crea una plantilla para el contenido de un mensaje de Slack que contenga una descripción de todas las alertas desactivadas y resueltas, incluidas sus etiquetas, anotaciones y la URL del panel de control:

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 crear una plantilla para el contenido de un mensaje de Slack

  1. Crea una plantilla llamada slack con dos plantillas en el contenido: slack.print_alert yslack.message.

    La slack.print_alert plantilla se utiliza para imprimir las etiquetas, las anotaciones y la URL del panel, mientras que la slack.message plantilla contiene la estructura de la notificación.

    {{ 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 la plantilla al crear la integración de su punto de contacto colocándola en el campo del cuerpo del texto con la palabra clave. template

    {{ template "slack.message" . }}

Crea plantillas para correo electrónico y Slack con plantillas compartidas

En lugar de crear plantillas de notificaciones independientes para cada punto de contacto, como el correo electrónico y Slack, puedes compartir la misma plantilla.

Por ejemplo, si quieres enviar un correo electrónico con este asunto y un mensaje de Slack con este título1 firing alerts, 0 resolved alerts, puedes crear una plantilla compartida.

Para crear una plantilla compartida

  1. Cree una plantilla llamada common.subject_title con el siguiente contenido:

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

  2. Para el correo electrónico, ejecuta la plantilla desde el campo de asunto de la integración de tu punto de contacto de correo electrónico:

    {{ template "common.subject_title" . }}

  3. En el caso de Slack, ejecuta la plantilla desde el campo de título de tu integración de puntos de contacto de Slack:

    {{ template "common.subject_title" . }}

Usa plantillas de notificaciones

Usa plantillas en los puntos de contacto para personalizar tus notificaciones.

Para usar una plantilla al crear un punto de contacto

  1. En el menú de alertas, selecciona Puntos de contacto para ver una lista de los puntos de contacto existentes.

  2. Selecciona Añadir punto de contacto. Como alternativa, puede editar un punto de contacto existente seleccionando el icono Editar (lápiz) situado junto al punto de contacto que desee editar.

  3. Introduzca las plantillas que desee utilizar en uno o más campos, como Mensaje o Asunto. Para introducir una plantilla, utilice el formulario {{ template "template_name" . }} y sustituya template_name por el nombre de la plantilla que desee utilizar.

  4. Haga clic en Guardar punto de contacto.