本文档介绍了如何在信息中心的图表上显示事件。事件是指影响系统操作的 activity,例如部署或崩溃。在排查问题时,显示事件可以帮助您关联来自不同来源的数据。
您可以在 Google Cloud 控制台的信息中心页面中列出的大多数信息中心上显示事件。如需配置信息中心显示的事件类型,您可以使用 Google Cloud 控制台。对于自定义信息中心,您还可以使用 Cloud Monitoring API。
如何识别事件
信息中心通过分析通过您的 Google Cloud 项目中的 Cloud Logging 接收器的日志条目来查询事件。这些日志条目包括项目生成的日志条目以及路由到项目的日志条目。
如需在发生其中某个事件时收到通知,您可以创建基于日志的提醒政策。在提醒政策中,请使用事件类型页面上提供的查询。
事件的显示方式
对于所有事件,当这些事件发生时,系统都会为信息中心上的图表添加注释。通过分析日志条目识别的事件会显示单一时间引用。
以下屏幕截图展示的图表显示了通过分析日志条目识别的一个事件:
如上一个屏幕截图所示,事件的提示包含如下信息:
- 事件名称。
- 导致事件的 Google Cloud 服务或资源。
- 活动的日期和时间。
- 一个查看按钮,点击此按钮可打开一个页面,其中显示了有关该事件的更多信息。例如,它可能会打开日志浏览器,以便您查看日志条目。
信息中心过滤条件用于限制信息中心显示的数据,通常可过滤时间序列数据和事件。
准备工作
如需获取在信息中心查看和显示事件所需的权限,以及创建提醒政策,请让管理员授予您项目的以下 IAM 角色:
-
查看和创建信息中心和提醒政策:
Monitoring Editor (
roles/monitoring.editor
)。 -
查看和显示通过在您的 Google Cloud 项目中创建的非数据访问日志条目所识别的事件:
日志查看器 (
roles/logging.viewer
)。 -
查看和显示根据您的 Google Cloud 项目中创建的任何日志条目所标识的事件:
Private Logs Viewer (
roles/logging.privateLogViewer
)。
如需详细了解如何授予角色,请参阅管理访问权限。
显示事件
如需查看可与日志浏览器或基于日志的提醒政策搭配使用的事件类型列表、问题排查参考信息和查询,请参阅事件类型页面。
控制台
如需在信息中心内显示事件,请执行以下操作:
-
在 Google Cloud 控制台中,转到
信息中心页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 选择要查看的信息中心。
在信息中心的工具栏中,确保
事件切换开关处于开启状态。
如果未显示
事件切换开关,则信息中心将无法显示事件。
点击选择事件类型,选择您希望信息中心显示的事件类型,然后执行以下操作之一:
如果您正在查看自定义信息中心,并希望保存事件类型选择,请点击固定所选内容。如果您在信息中心已停用自动保存功能,请转到信息中心的工具栏,然后点击保存。
固定所选内容时,您将修改信息中心的 JSON 定义。因此,重新打开信息中心时,系统会加载您的选择,并且信息中心会显示相应事件类型的注释。
否则,请点击确定。
在更新要显示的事件类型列表后,Cloud Monitoring 会发出查询,这需要一些时间,然后向信息中心上的图表添加注解。
如需查看事件摘要或访问日志条目的链接,请使用指针激活提示。
API
如需将自定义信息中心配置为显示事件,请在 Dashboard
对象中添加 annotations
字段。annotations
字段包含 DashboardAnnotations
对象的实例,后者包含两个字段:
defaultResourceName
字段列出了 Google Cloud 项目用于搜索事件的信息中心级默认值。如果您未指定此字段,则会搜索所选项目。EventAnnotation
对象数组。每个对象都包含以下内容:displayName
字段,可让您定义特定于事件的切换开关上的标签。如果未指定此字段或此字段的值为空字符串,系统会显示事件的默认名称。enabled
字段,用于控制事件切换开关的值。如果为true
,切换开关处于on
位置,并且事件会显示在信息中心内。如果为false
,切换开关处于off
位置。eventType
字段,包含来自EventType
枚举的值。filter
字段,可让您指定要附加到特定于事件的查询的查询。如果此字段的值为空字符串,则使用针对特定事件的查询。resourceNames
字段,可让您定义要搜索事件的 Google Cloud 项目列表。当此字段为空数组时,系统将搜索您所选的项目。
下面显示了集群更新事件的 annotations
对象示例。此示例中的 filter
字段将事件限制为特定集群:
"annotations": {
"defaultResourceNames": [],
"eventAnnotations": [
{
"displayName": "",
"enabled": true,
"eventType": "GKE_CLUSTER_UPDATE",
"filter": "resource.labels.cluster_name=my-cluster",
"resourceNames": []
}
]
}
如需详细了解如何使用 Cloud Monitoring API 创建信息中心,请参阅通过 API 创建和管理信息中心和示例:在信息中心上启用事件。
查看活动详情
在查看显示事件注释的图表时,您可以使用提示中提供的链接来访问更多信息。
如要查看特定活动的详细信息,请点击查看。
通过查看按钮打开的 Google Cloud 控制台页面由事件类型决定。例如,对于正常运行时间检查事件,此按钮将打开正常运行时间检查的信息中心。对于其他事件类型,日志浏览器可能会打开。
创建提醒政策
通过分析流经您的 Google Cloud 项目中的 Cloud Logging 接收器的日志条目来识别事件时,您可以通过配置基于日志的提醒,在这些事件发生时收到通知。基于日志的提醒政策在收到日志条目时查询日志条目。当查询返回非空结果时,系统会创建一个突发事件并发送通知。
控制台
如需创建基于日志的提醒,请执行以下操作:
如果您尚未配置通知渠道,请执行以下操作:
-
在 Google Cloud 控制台中,转到 notifications 提醒页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 点击 Edit notification channel。
- 转到您要配置的通知渠道类型,点击新增,然后完成对话框。
-
-
在 Google Cloud 控制台中,转到 Logs Explorer 页面。
如果您使用搜索栏查找此页面,请选择子标题为 Logging 的结果。
在工具栏中,选择创建提醒。
输入提醒政策的名称,然后点击下一步。
在定义要发出提醒的日志条目部分中,输入查询或更新在选择创建提醒时从查询窗格中复制的查询。
对于每种事件类型,事件类型页面都会列出一个适合在基于日志的提醒政策中使用的查询。
完整填写对话框,然后点击保存。
API
如需使用 Cloud Monitoring API 创建基于日志的提醒政策,请执行以下操作:
确定要包含在提醒政策条件中的查询。对于每种事件类型,事件类型页面都会列出适合在基于日志的提醒政策中使用的查询。
创建包含提醒政策表示法的 JSON 文件。如需详细了解此步骤和示例,请参阅设计提醒政策。
调用 alertPolicies.create API 方法。例如,您可以发出
gcloud alpha monitoring policies create
命令。
隐藏事件
控制台
如需隐藏所有事件,请在信息中心工具栏中确保将 toggle_off 事件切换开关关闭。
如需隐藏一种类型的事件,请将该事件类型的切换开关设置为关闭。
API
如需在自定义信息中心内隐藏一种类型的事件,请找到相应事件类型的 EventAnnotation
对象,然后将 enabled
字段设置为 false
。
如需详细了解如何使用 Cloud Monitoring API,请参阅按 API 创建和管理信息中心。