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 variables

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

Documentación en correo electrónico

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

Variable Valor
condition.name El nombre del recurso REST de la condición, como projects/foo/alertPolicies/1234/conditions/5678
condition.display_name El nombre visible de una condición, como CPU usage increasing rapidly
metric.type El tipo de métrica, como compute.googleapis.com/instance/cpu/utilization
metric.display_name El nombre visible del tipo de métrica, como CPU utilization
metric.label.[KEY] El valor de la etiqueta de 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 visible de una política, como High CPU rate of change
project El ID del proyecto del espacio 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 del recurso supervisado, como api
resource.label.[KEY] El valor de la etiqueta de recurso [KEY]1,3

1 Por ejemplo, ${resource.label.zone} se reemplaza por el valor de la etiqueta zone. Los valores de estas variables están sujetos a la agrupación; consulta las siguientes Notas para obtener más información.
2 Las etiquetas de usuario en una política solo se pueden configurar con la API de Monitoring.
3 Para recuperar el valor de la etiqueta project_id en un recurso supervisado en la política de alertas, usa ${resource.project}.

Notas:

  • Solo se admiten las variables en la tabla. No puedes combinarlas en expresiones más complejas, como ${varname1 + varname2}.
  • Los valores de algunas variables (por ejemplo, resource.project, metric.label.[KEY], resource.label.[KEY] y metadata.user_label.[KEY]) derivan de series temporales. Los valores pueden ser null si no se muestran valores de la consulta de series temporales. Algo que puede hacer que las variables tengan valores null es si tu política de alertas usa una agregación de series cruzadas (por ejemplo, calcular la suma en cada una de las series temporales que coinciden con el filtro). Cuando se usa una agregación de series cruzadas, las variables no usadas en la agrupación se descartan y tendrán valores null si se mencionan en la sustitución de variables.
  • Para incluir la string literal ${ en tu documentación, escapa el símbolo $ con un segundo símbolo $; $${ se procesará como ${ en tu documentación.
  • Estas variables se reemplazan por sus valores solo en las notificaciones enviadas a través de canales de notificación. En la consola de Stackdriver Monitoring, cuando se muestra la documentación, ves las variables, no los valores. En los ejemplos de la consola, se incluyen descripciones de incidentes y la vista previa de la documentación cuando se crea una política de alertas.

Usa controles de canal

El texto en el campo de documentación también puede incluir caracteres especiales que usa 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 relevante de Slack recibe el campo de documentación como parte de la notificación, esta línea activa un mensaje adicional para el usuario backendoncall que, por ejemplo, indica 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 que proporciona el proveedor del canal.