文档模板中的变量

本页介绍与提醒政策关联的文档模板中可使用的变量和特定于渠道的控制。

使用变量

除 Markdown 外,您还可以使用 ${varname} 形式的变量来按需调整文档内容。当文档随通知一起发送时,字符串 ${varname} 将被替换为 varname 的值。以下屏幕截图显示了电子邮件通知中包含的文档,该文档是以添加文档部分描述的文档模板创建的:

电子邮件中的文档

文档字段中可使用以下变量:

变量
condition.name 条件的 REST 资源名称,例如 projects/foo/alertPolicies/1234/conditions/5678
condition.display_name 条件的显示名称,例如 CPU usage increasing rapidly
metric.type 指标类型,例如 compute.googleapis.com/instance/cpu/utilization
metric.display_name 指标类型的显示名称,例如 CPU utilization
metric.label.[KEY] 指标标签 key1 的值
policy.user_label.[KEY] 用户标签 key1,2 的值
policy.name 政策的 REST 资源名称,例如 projects/foo/alertPolicies/1234
policy.display_name 政策的显示名称,例如 High CPU rate of change
project 工作区的项目 ID,例如 a-gcp-project
resource.project 提醒政策的受监控资源的项目 ID
resource.type 受监控资源的类型,例如 api
resource.label.[KEY] 资源标签 key1 的值

1 例如,将 ${resource.label.zone} 替换为 zone 标签的值。
2 只能通过 Monitoring API 来设置政策中的用户标签。

注意:

  • 只有上表中的变量受支持。您不能将它们组合成更复杂的表达式,例如 ${varname1 + varname2}

  • 要将文字字符串 ${ 包含在您的文档中,请再使用一个 $ 符号对 $ 符号进行转义,即 $${ 将在您的文档中呈现为 ${

使用渠道控制功能

文档字段中的文本还可以包含通知渠道本身用来控制格式和通知的特殊字符。

例如,Slack 使用 @ 表示提及。您可以使用此字符将通知链接到特定用户。假设您在文档字段中包含了这样一个字符串:

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

当相关 Slack 频道收到包括该文档字段的通知时,此行会触发向用户 backendoncall 发送一条额外的消息,例如 policy High CPU rate of change triggered an incident

这些附加选项是特定于渠道的。如需详细了解可用选项,请参考渠道供应商提供的文档。

此页内容是否有用?请给出您的反馈和评价:

发送以下问题的反馈:

此网页
Stackdriver Monitoring
需要帮助?请访问我们的支持页面