Variables en las plantillas de documentación

En esta página, se describen las variables y los controles de canal específicos que están disponibles para su uso en la plantilla de documentación asociada con una política de alertas.

Usa variantes

Además de Markdown, puedes usar variantes de la forma ${varname} para adaptar el contenido de tu documentación. Cuando la documentación se envía con una notificación, la string ${varname} se reemplaza con el valor de varname. La siguiente captura de pantalla muestra la documentación incluida en una notificación por correo electrónico, creada a partir de la plantilla de documentación descrita en Agregar documentación:

Las siguientes variantes están disponibles para su uso en los campos de documentación:

Variable	Valor
condition.name	El nombre del recurso REST del estado, como projects/foo/alertPolicies/1234/conditions/5678
condition.display_name	El nombre comercial de un estado, como CPU usage increasing rapidly
metric.type	El tipo de métrica, como compute.googleapis.com/instance/cpu/utilization
metric.display_name	El nombre comercial del tipo de métrica, como CPU utilization
metric.label.[KEY]	El valor de la etiqueta métrica key^1
policy.user_label.[KEY]	El valor de la etiqueta de usuario key^1,2
policy.name	El nombre del recurso REST de la política, como projects/foo/alertPolicies/1234
policy.display_name	El nombre comercial de una política, como High CPU rate of change
project	El ID del proyecto del lugar de trabajo, como a-gcp-project
resource.project	El ID del proyecto del recurso supervisado de la política de alertas
resource.type	El tipo de recurso supervisado, como api
resource.label.[KEY]	El valor de la etiqueta de recurso key^1

¹ Por ejemplo, ${resource.label.zone} se reemplaza con el valor de la etiqueta de zone.
² Las etiquetas de usuario en una política solo se pueden configurar con la API de Monitoring.

Notas:

• Solo se admiten las variantes en la tabla. No puedes combinarlas con expresiones más complejas, como ${varname1 + varname2}.

• Para incluir la string literal ${ en tu documentación, reemplaza el símbolo $ con un segundo símbolo $, y $${ se procesará como ${ en tu documentación.

Usa controles de canal

El texto en el campo de documentación también puede incluir caracteres especiales usados por el propio canal de notificación para controlar el formato y las notificaciones.

Por ejemplo, Slack usa @ para las menciones. Puedes usar esto para vincular la notificación a un usuario específico. Supongamos que incluyes una string como esta en el campo de documentación:

<@backendoncall> policy ${policy.display_name} triggered an incident

Cuando el canal Slack relevante recibe el campo de documentación como parte de la notificación, esta línea activa un mensaje adicional para el usuario backendoncall, por ejemplo, policy High CPU rate of change triggered an incident.

Estas opciones adicionales son específicas de los canales. Para obtener más información sobre lo que podría estar disponible, consulta la documentación proporcionada por el proveedor del canal.