使用用户定义的文档为通知添加注释

Cloud Monitoring API

使用 subject 字段配置通知主题行 提醒政策 documentation 部分。

Google Cloud 控制台

使用 通知主题行字段的 创建提醒政策页面的通知和名称部分。

Cloud Monitoring API

使用 content 字段配置文档内容 提醒政策 documentation 部分。

Google Cloud 控制台

使用 Documentation 字段（位于 创建提醒政策页面的通知和名称部分。

Cloud Monitoring API

Cloud Monitoring API 中配置的文档链接显示在 以下通知类型：

• 快速链接标题下的电子邮件
• PagerDuty
• Pub/Sub
• Webhook

要配置链接，请将 Link 添加到 documentation 的提醒政策。 每个链接由一个 display_name 和 url 表示。您最多可以添加 三个链接

以下配置使用 links 和 1 个网址 创建指向突发事件策略方案的链接。网址包含一个变量 通知接收者可以根据 发生突发事件的受监控的资源：

"links" [
  {
    "displayName": "Playbook",
    "url": "https://myownpersonaldomain.com/playbook?name=${resource.type}"
  }
]

Google Cloud 控制台

在 Google Cloud 控制台中配置的文档链接会与 以下通知类型中的其他文档内容：

• Policy Documentation 标题下的电子邮件
• PagerDuty
• Pub/Sub
• Slack
• Webhook

您可以通过包含链接来添加指向文档内容的链接 您的提醒政策的 Documentation 字段中。例如， 以下文档列出了客户策略方案的网址：

### Troubleshooting and Debug References

Playbook: https://myownpersonaldomain.com/playbook?name=${resource.type}

Cloud Monitoring API

  "documentation": {
    "content": "### CPU utilization exceeded\n\n### Summary\n\nThe ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} in the project ${resource.project} has exceeded 5% for over 60 seconds.\n\n#### Additional resource information\n\nCondition resource name: ${condition.name}  \nAlerting policy resource name: ${policy.name}",
    "mimeType": "text/markdown",
    "subject": "Alert: ${metric.display_name} exceeded",
    "links": [
      {
        "displayName": "Playbook",
        "url": "https://myownpersonaldomain.com/playbook?name=${resource.type}"
      },
      {
        "displayName": "Repository with debug scripts",
        "url": "https://altostrat.com"
      },
      {
        "displayName": "Google Cloud dashboard",
        "url": "https://example.com"
      }
    ]
  }

下图显示了此模板在电子邮件中的显示方式 通知：

Google Cloud 控制台

### CPU utilization exceeded

#### Summary

The ${metric.display_name} of the ${resource.type}
${resource.label.instance_id} in the project ${resource.project} has
exceeded 5% for over 60 seconds.

#### Additional resource information

Condition resource name: ${condition.name}  
Alerting policy resource name: ${policy.name}  

#### Troubleshooting and Debug References

Playbook: https://myownpersonaldomain.com/playbook?name=${resource.type}  
Repository with debug scripts: https://altostrat.com  
${resource.type} dashboard: https://example.com

下图显示了此模板在电子邮件中的显示方式 通知：