Variáveis em modelos de documentação

Nesta página, descrevemos as variáveis e os controles específicos do canal disponíveis para uso no modelo de documentação associado a uma política de alertas.

Como usar variáveis

Além do Markdown, é possível usar variáveis ​​do formulário ${varname} para adaptar o conteúdo da documentação. Quando ela é enviada com uma notificação, a string ${varname} é substituída pelo valor de varname. A captura de tela a seguir mostra a documentação incluída em uma notificação por e-mail, criada a partir do modelo de documentação descrito em Adicionar documentação:

Documentação no e-mail

As variáveis a seguir ​​estão disponíveis para uso nos campos de documentação:

Variável Valor
condition.name O nome do recurso REST da condição, como projects/foo/alertPolicies/1234/conditions/5678
condition.display_name O nome de exibição de uma condição, como CPU usage increasing rapidly
metric.type O tipo de métrica, como compute.googleapis.com/instance/cpu/utilization
metric.display_name O nome de exibição do tipo de métrica, como CPU utilization
metric.label.[KEY] O valor do marcador de métrica key1
policy.user_label.[KEY] O valor do marcador de usuário key1,2
policy.name O nome do recurso REST da política, como projects/foo/alertPolicies/1234
policy.display_name O nome de exibição de uma política, como High CPU rate of change
project O código do projeto do espaço de trabalho, como a-gcp-project
resource.project O código do projeto do recurso monitorado relacionado à política de alertas
resource.type O tipo do recurso monitorado, como api
resource.label.[KEY] O valor do marcador de recurso key1

1 Por exemplo, ${resource.label.zone} é substituído pelo valor do rótulo zone.
2 Os marcadores de usuário em uma política só podem ser definidos usando a API Monitoring.

Observações:

  • Apenas as variáveis na tabela são compatíveis. Não é possível combiná-las em expressões mais complexas como ${varname1 + varname2}.

  • Para incluir a string literal ${ na documentação, insira o caractere de escape $ com um segundo $, e $${ será renderizado como ${ na documentação.

Como usar controles de canal

O texto no campo de documentação também pode incluir caracteres especiais usados pelo próprio canal de notificação para controlar a formatação e as notificações.

Por exemplo, o Slack usa @ nas menções. Isso pode ser usado para vincular a notificação a um usuário específico. Vamos supor que você inclua uma string como esta no campo de documentação:

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

Quando o campo de documentação é recebido pelo canal Slack relevante como parte da notificação, essa linha aciona uma mensagem adicional para o backendoncall do usuário que, por exemplo, policy High CPU rate of change triggered an incident.

Essas opções adicionais são específicas para os canais. Para saber mais sobre o que está disponível, consulte a documentação oferecida pelo fornecedor do canal.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Stackdriver Monitoring
Precisa de ajuda? Acesse nossa página de suporte.