Utiliza variables en los mensajes de notificación para mostrar mensajes condicionales y dirigir la notificación a diferentes equipos utilizando variables condicionales, o para enriquecer tu contenido utilizando variables de atributo y etiqueta y variables de plantilla.

Variables condicionales

Las variables condicionales utilizan la lógica de if-else para mostrar un mensaje diferente dependiendo del estado del monitor y de los detalles de cómo se activó. Estas variables pueden utilizarse dentro del asunto o del cuerpo del mensaje de notificación.

Están disponibles las siguientes variables condicionales:

Ejemplos

La variable condicional debe tener un par de apertura y cierre con el texto y @-notifications en medio.

{{#is_alert}}
  <ALERT_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_alert}}

{{#is_warning}}
  <WARNING_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_warning}}

{{#is_recovery}}
  <RECOVERY_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_recovery}}

{{#is_match "<TAG_VARIABLE>.name" "<COMPARISON_STRING>"}}
  Esto aparece si <COMPARISON_STRING> se incluye en <TAG_VARIABLE>.
{{/is_match}}

{{#is_match "role.name" "db"}}
  Esto aparece si el host que activa la alerta contiene `db`
  en el nombre de rol. @db-team@company.com
{{/is_match}}

{{#is_match "role.name" "db" "database"}}
  Esto aparece si el host que activa la alerta contiene `db` o `database`
  en el nombre de rol. @db-team@company.com
{{/is_match}}

{{^is_match "role.name" "db"}}
  Esto aparece si la etiqueta del rol no contiene `db`.
  @slack-example
{{/is_match}}

{{#is_match "role.name" "db"}}
  Esto aparece si el host que activa la alerta contiene `db`
  en el nombre de rol. @db-team@company.com
{{else}}
  Esto aparece si la etiqueta del rol no contiene `db`.
  @slack-example
{{/is_match}}

{{#is_exact_match "<TAG_VARIABLE>.name" "<COMPARISON_STRING>"}}
  Esto aparece si <COMPARISON_STRING> es exactamente <TAG_VARIABLE>.
{{/is_exact_match}}

{{#is_exact_match "host.name" "production"}}
  Esto aparece si el host que activó la alerta se llama exactamente
producción. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "host.name" "production" "staging"}}
  Esto aparece si el host que activó la alerta se llama exactamente
  producción o staging. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "value" "<VALUE>"}}
  Esto aparece si el valor que infringió el umbral del monitor es exactamente <VALUE>.
{{/is_exact_match}}

{{#is_exact_match "value" "5"}}
  Esto aparece si el valor que ha superado el umbral del monitor es 5. @dev-team@company.com
{{/is_exact_match}}

{{#is_renotify}}
{{#is_match "env" "production"}}
  Este es un mensaje de escalada enviado a @dev-team@company.com
{{/is_match}}
{{/is_renotify}}

{{^is_renotify}}
Este monitor alerta y envía un primer mensaje a @dev-team@company.com

Para resolver este monitor sigue los pasos:
1. Go there
2. Do this
{{/is_renotify}}

Esta parte es genérica y se envía para el primer desencadenante y el mensaje de escalada.

{{#is_renotify}}
  Este es el mensaje de escalada @dev-team@company.com
{{/is_renotify}}

Esta parte es genérica y se envía tanto para el primer desencadenante como para el mensaje de escalada.

Este es el mensaje de escalada @dev-team@company.com

Si configuras un bloque condicional para una transición de estado en condiciones alert o warning con un identificador @-notifications, se recomienda configurar una condición recovery correspondiente para que se envíe una notificación de recuperación al identificador.

Nota: Cualquier texto o identificador de notificación colocado fuera de las variables condicionales configuradas se invoca con cada transición de estado del monitor. Cualquier texto o identificador de notificación colocado dentro de las variables condicionales configuradas solo se invoca si la transición de estado del monitor coincide con su condición.

Variables de atributos y etiquetas

Utiliza variables de atributo y etiqueta para mostrar mensajes de alerta personalizados, informativos y específicos para ayudar a comprender la naturaleza de la alerta.

Nota: Si el monitor está configurado para recuperarse en condiciones sin datos (por ejemplo, cuando no hay eventos que coincidan con la consulta), el mensaje de recuperación no contiene datos. Para mantener la información en el mensaje de recuperación, agrupa por etiquetas adicionales, a las que se puede acceder mediante {{tag.name}}.

Variables de alerta múltiple

Configura variables de alertas múltiples en monitores de alerta múltiple en función de la dimensión seleccionada en el cuadro de grupo de alertas múltiples. Enriquecer la notificación para incluir dinámicamente el valor asociado al grupo por dimensión en cada alerta.

Si una métrica está etiquetada con cualquier etiqueta siguiendo la sintaxis key:value y la consulta del monitor está agrupada por esta etiqueta, utiliza la variable:

{{ key.name }}

En cada alerta se muestra el value asociado a la notificación key. Si un grupo está etiquetado con varios values asociados a la misma key, el mensaje de alerta muestra una cadena separada por comas de todos los valores, en orden lexicográfico.

Ejemplo: Si tu monitor activa una alerta para cada env, entonces la variable {{env.name}} está disponible en tu mensaje de notificación.

Clave de etiqueta con punto

Si tu clave de etiqueta tiene un punto en ella, incluye corchetes alrededor de la clave completa cuando se utiliza una variable de etiqueta. Por ejemplo, si tu etiqueta es dot.key.test:five y tu monitor está agrupado por dot.key.test, utiliza:

{{[dot.key.test].name}}

Si la etiqueta está en un evento y estás utilizando un monitor de evento, utiliza:

{{ event.tags.[dot.key.test] }}

Monitores de logs, monitores de Trace Analytics, monitores RUM y monitores de eventos pueden usar facetas como variables si el monitor está agrupado por facetas. Si un monitor de log está agrupado por @facet_key, utiliza la variable:

{{ @facet_key.name }}

Ejemplo: Para incluir información específica de un grupo en un monitor de log de alerta múltiple agrupado por @machine_id:

Esta alerta se activó en {{ @machine_id.name }}

Si tu faceta tiene puntos, utiliza corchetes alrededor de la faceta, por ejemplo:

{{ [@network.client.ip].name }}

Personalización de las notificaciones en función del grupo

Cuando tu consulta está agrupada por dimensiones específicas, puedes enriquecer las notificaciones con metadatos dinámicos asociados con el grupo.

Grupo de consulta por host

Si tu monitor activa una alerta para cada host, entonces las variables de etiqueta {{host.name}} y {{host.ip}} están disponibles así como cualquier etiqueta de host que esté disponible en este host. Para ver una lista de las variables de etiqueta según tu selección de etiquetas, haz clic en Use message template variables en la sección Say what’s happening.

Variables de metadatos específicas de host:

• Versión del Agent: {{host.metadata_agent_version}}
• Máquina: {{host.metadata_machine}}
• Plataforma: {{host.metadata_platform}}
• Procesador: {{host.metadata_processor}}

Consulta agrupada por kube_namespace y kube_cluster_name

Si tu monitor activa una alerta para cada kube_namespace y kube_cluster_name, entonces puedes acceder a cualquier atributo del espacio de nombres.

Variables de metadatos del espacio de nombres:

• Nombre del clúster: {{kube_namespace.cluster_name}}
• Nombre del espacio de nombres: {{kube_namespace.display_name}}
• Estado del espacio de nombres: {{kube_namespace.status}}
• Etiquetas del espacio de nombres: {{kube_namespace.labels}}

La siguiente tabla contiene todos los atributos disponibles:

Consulta agrupada por pod_name, kube_namespace y kube_cluster_name

Si tu monitor activa una alerta para cada pod_name,kube_namespace y kube_cluster_name, entonces puedes acceder a cualquier atributo del pod.

Variables de metadatos del pod:

• Nombre del clúster: {{pod_name.cluster_name}}
• Nombre del pod: {{pod_name.name}}
• Fase del pod: {{pod_name.phase}}

La siguiente tabla contiene todos los atributos disponibles:

Unión de variables de atributo/etiqueta

Disponible para monitores de log, monitores de Trace Analytics (APM), monitores RUM, monitores CI y monitores de Database Monitoring.

Para incluir cualquier atributo o etiqueta de un log, un tramo de traza, un evento RUM, un CI Pipeline, o un evento de CI Test que coincida con la consulta del monitor, utiliza las siguientes variables:

Para cualquier par key:value, la variable {{log.tags.key}} se convierte en value en el mensaje de alerta.

Ejemplo: Si un monitor de log está agrupado por @http.status_code, para incluir el mensaje de error o etiquetas de infraestructura en el mensaje de notificación, utiliza las variables:

{{ log.attributes.[error.message] }}
{{ log.tags.env }}
...

El mensaje muestra el atributo error.message de un log elegido que coincide con la consulta, si el atributo existe.

Si un monitor utiliza formulas y funciones en sus consultas, los valores se resuelven con eventos que se extraen de la primera consulta.

Atributos reservados

Los eventos de logs, Event Management, tramos, RUM, CI Pipeline y CI Test tienen atributos reservados genéricos, que puedes usar en variables con la siguiente sintaxis:

Si el evento coincidente no contiene el atributo en su definición, la variable se muestra vacía.

Enlace de explorador

Utiliza {{log.link}}, {{span.link}}, {{rum.link}} y {{issue.link}} para fortalecer la notificación con un enlace a Log Explorer, Trace Explorer, RUM Explorer o Error Tracking, en el contexto de eventos que coincida con la consulta.

Comprobar variables de monitor

Para comprobar las variables de monitor (check personalizado y check de integración), la variable {{check_message}} está disponible y muestra el mensaje especificado en el check personalizado o el check de integración.

Variables compuestas de monitor

Los monitores compuestos pueden acceder al valor y al estado asociados a los submonitores en el momento en que se activa la alerta.

Por ejemplo, si tu monitor compuesto tiene el submonitor a, puedes incluir el valor de a con:

{{ a.value }}

Para recuperar el estado del submonitor a, utiliza:

{{ a.status }}

Los valores posibles para el estado son: OK, Alert, Warn y No Data.

Los monitores compuestos también admiten variables de etiqueta del mismo modo que sus monitores subyacentes. Siguen el mismo formato que otros monitores, siempre que los monitores subyacentes estén agrupados por la misma etiqueta o faceta.

Por ejemplo, supón que tu monitor compuesto tiene un submonitor a , que es un monitor de logs. Puedes incluir el valor de cualquier etiqueta o faceta de a con:

{{ a.log.message }} o {{ a.log.my_facet }}

Fuga de caracteres

El contenido de las variables se fuga por defecto. Para evitar que se fuge contenido como JSON o código, utiliza llaves triples en lugar de dobles, por ejemplo: {{{event.text}}}.

Variables de plantilla

Utiliza variables de plantilla para personalizar tus notificaciones de monitor. Las variables incorporadas son:

Variables activadas

Las variables de plantilla de monitor {{first_triggered_at}}, {{first_triggered_at_epoch}}, {{last_triggered_at}} y {{last_triggered_at_epoch}} reflejan los valores cuando un monitor cambia de estado, NO cuando se produce un nuevo evento de monitor. La renotificación de eventos muestran la misma variable de plantilla si el estado del monitor no ha cambiado. Utiliza {{triggered_duration_sec}} para mostrar la duración en el momento del evento del monitor.

{{first_triggered_at}} se establece cuando el grupo de monitor pasa de OK a un estado distinto de OK o cuando aparece un nuevo grupo en un estado distinto de OK. {{last_triggered_at}} se establece cuando el grupo de monitor pasa a un estado distinto de OK independientemente de su estado anterior (incluido WARN → ALERT, ALERT → WARN). Además, {{last_triggered_at}} se establece cuando un nuevo grupo aparece en un estado distinto a OK. La diferencia es que {{last_triggered_at}} es independiente de su estado anterior.

Ejemplo: Cuando el monitor pasa de OK → WARN, los valores de {{first_triggered_at}} y {{last_triggered_at}} tienen ambos la marca temporal A. La tabla siguiente muestra los valores hasta que el monitor se recupera.

Evaluación

Las variables de plantilla que devuelven valores numéricos admiten operaciones y funciones, que permiten realizar operaciones matemáticas o cambios de formato en el valor. Para más detalles, consulta Evaluación de variables de plantilla.

Hora local

Utiliza la función local_time para añadir otra fecha en tu notificación en la zona horaria de elección. Esta función transforma una fecha en su hora local: {{local_time 'time_variable' 'timezone'}}. Por ejemplo, para añadir la última hora activada del monitor en la zona horaria de Tokio en tu notificación, incluye lo siguiente en el mensaje de notificación:

{{local_time 'last_triggered_at' 'Asia/Tokyo'}}

El resultado se muestra en el formato ISO 8601: yyyy-MM-dd HH:mm:ss±HH:mm, por ejemplo 2021-05-31 23:43:27+09:00. Consulta la lista de zonas horarias de la base de datos tz, en particular la columna de nombre de la base de datos TZ, para ver la lista de valores de zonas horarias disponibles.

Avanzado

Identificadores dinámicos

Utiliza variables de etiqueta para crear dinámicamente identificadores de notificación y notificaciones de ruta al equipo o servicio correcto basado en el tipo de problema detectado por tu monitor.

Ejemplo: Si tu monitor consulta una métrica y la agrupa por una etiqueta de service, puedes hacer que tus notificaciones se enruten a diferentes canales de Slack según el servicio que falle:

@slack-{{service.name}} Hay un problema en curso con {{service.name}}.

Si tu monitor empieza a fallar en el grupo service:ad-server, la notificación se envía al canal de Slack #ad-server con el siguiente contenido:

@slack-ad-server Hay un problema en curso con ad-server.

Al crear identificadores dinámicos con atributos que no siempre están presentes, pueden surgir problemas con la entrega de notificaciones. Si falta un atributo, la variable se muestra vacía en el mensaje de notificación, lo que genera un identificador no válido.

Para evitar notificaciones perdidas al usar identificadores dinámicos con estas variables, asegúrate de agregar un identificador alternativo:

{{#is_match "kube_namespace.owner" ""}}
  @slack-example
{{/is_match}}

Enlaces dinámicos

Utiliza variables de etiqueta para permitir la creación de URL dinámicas que enlacen a tu equipo con un recurso apropiado. Por ejemplo, puedes proporcionar enlaces a páginas dentro de Datadog como dashboards, mapa de host y monitores.

https://app.datadoghq.com/dash/integration/system_overview?tpl_var_scope=host:{{host.name}}

https://app.datadoghq.com/dash/integration/<INTEGRATION_NAME>?tpl_var_scope=host:{{host.name}}

https://app.datadoghq.com/dashboard/<DASHBOARD_ID>/<DASHBOARD_NAME>?from_ts={{eval "last_triggered_at_epoch-10*60*1000"}}&to_ts={{eval "last_triggered_at_epoch+10*60*1000"}}&live=false

https://app.datadoghq.com/infrastructure/map?filter=service:{{service.name}}

https://app.datadoghq.com/monitors/manage?q=scope:host:{{host.name}}

https://app.datadoghq.com/logs?from_ts={{eval "last_triggered_at_epoch-10*60*1000"}}&to_ts={{eval "last_triggered_at_epoch+10*60*1000"}}&live=false

Comentarios

Para incluir un comentario en el mensaje de monitor que solo aparezca en la pantalla de edición del monitor, utiliza la sintaxis:

{{!-- this is a comment --}}
{{!-- this is a comment }}

Formato sin procesar

Si tu mensaje de alerta necesita enviar llaves dobles, como {{ <TEXT> }}, utiliza el formato {{{{raw}}}}. Por ejemplo, el siguiente:

{{{{raw}}}}
{{ <TEXT_1> }} {{ <TEXT_2> }}
{{{{/raw}}}}

Salidas:

{{ <TEXT_1> }} {{ <TEXT_2> }}

Las ayudas ^|# utilizadas en las variables condicionales no pueden utilizarse con el formato {{{{raw}}}} y deben eliminarse. Por ejemplo, para mostrar texto sin formato con la variable condicional {{is_match}}, utiliza la siguiente plantilla:

{{{{is_match "host.name" "<HOST_NAME>"}}}}
{{ .matched }} the host name
{{{{/is_match}}}}

Si host.name coincide con <HOST_NAME>, la plantilla muestra:

{{ .matched }} the host name

Codificación URL

Si tu mensaje de alerta incluye información que debe codificarse en una URL (por ejemplo, para redireccionamientos), utiliza la sintaxis {{ urlencode "<variable>"}}.

Ejemplo: Si tu mensaje de monitor incluye una URL al catálogo de servicio filtrado a un servicio específico, utiliza la variable de etiqueta service y añade la sintaxis {{ urlencode "<variable>"}} a la URL:

https://app.datadoghq.com/services/{{urlencode "service.name"}}

Referencias adicionales

Más enlaces, artículos y documentación útiles:

Realiza operaciones aritméticas y funciones con evaluaciones de variables de plantillaGUÍA Crear monitoresDOCUMENTACIÓN Notificaciones de monitorDOCUMENTACIÓN Gestionar los monitoresDOCUMENTACIÓN Realiza un curso para personalizar las notificaciones del monitor de alertasCENTRO DE APRENDIZAJE