本文档介绍了如何配置信息中心以显示事件注释。 事件是指影响部署或应用崩溃的 系统的运行。显示事件注释有助于您 从不同来源获取数据。
事件注释简介
您可以使用 Google Cloud 控制台的信息中心页面。 同样,您可以配置一些服务专用的 Observability 标签页, 例如用于 Compute Engine 和 Google Kubernetes Engine 的容器,以显示事件。 要配置 由信息中心或可观测性标签页显示, 可以使用 Google Cloud 控制台 您创建的信息中心就属于自定义信息中心 您也可以使用 Cloud Monitoring API。
除非您使用 Cloud Monitoring API 或采取措施来保存您的 事件类型选择,您的选择将仅适用于当前会话。 当您使用 Google Cloud 控制台时,固定您选择的设置可以保存它们。
如需查看事件类型列表、问题排查参考信息和其他信息, 请参阅事件类型页面。
推荐的事件类型
您可能会在信息中心或 可观测性标签页,即使您未选择任何事件类型也是如此:
- 提醒已打开。
- Personalized Service Health 事件, 。
- 对于每种资源,其数据会显示在 一种事件类型。
自动添加的事件类型为推荐的事件类型。 您可以将这些事件类型保持建议状态, 信息中心 JSON 或忽略这些建议,这将移除建议。确定 要保存的事件类型,请展开选择事件类型菜单,然后 查看已固定部分。
如何识别事件
信息中心会查询不同的数据源以识别事件 设置:
提醒事件的识别依据是 监控。提醒事件可提供有关 已打开 个事件。
Personalized Service Health 事件由 Monitoring 发送到 Service Health API 的查询。 这些事件会指明 Google Cloud 服务何时发生中断。
所有其他事件类型均通过分析 通过您的 Google Cloud 项目中的 Cloud Logging 接收器传递。 这些日志条目包括您的项目生成的日志条目 以及路由至您的项目 如需在发生这类事件时收到通知,您可以创建 基于日志的提醒政策在提醒政策中,使用查询 事件类型页面上提供的事件选项。
事件的显示方式
对于所有事件,在发生这些事件时,您信息中心的图表都会 注解。通过分析日志条目识别的事件 时间参考。相比之下,Service Health 事件则会显示 开始时间,然后图表的背景在这段时间内发生变化 事件。这些事件还会显示一个心形图标。
下面的屏幕截图显示了一个图表,其中显示了 通过分析日志条目识别的事件; Service Health 事件:
如上一张屏幕截图所示,事件的提示包括 例如:
- 事件名称。
- 活动的日期和时间。
- 对于 Service Health 事件,显示问题数量的条状标签 受影响的商品和地理位置。 要列出受影响的商品或位置,请将鼠标指针悬停在 相应条状标签。
- 一个查看按钮,点击此按钮可打开一个页面,其中显示了 事件的相关信息例如,它可能会打开日志浏览器, 以便查看日志条目 调用 Service Health 事件
信息中心过滤条件,可限制信息中心显示的数据 通常同时过滤时间序列数据和事件。
准备工作
-
获得在信息中心查看和显示事件所需的权限,以及 创建提醒政策 请让管理员授予您 项目的以下 IAM 角色:
-
查看和创建信息中心和提醒政策:
Monitoring Editor (
roles/monitoring.editor
)。 -
查看并显示根据您的 Google Cloud 项目中创建的非数据访问日志条目所识别的事件:
日志查看器 (
roles/logging.viewer
)。 -
查看和显示根据您的 Google Cloud 项目中创建的任何日志条目所标识的事件:
Private Logs Viewer (
roles/logging.privateLogViewer
)。 -
查看 Service Health 事件:
Personalized Service Health Viewer (
roles/servicehealth.viewer
)
如需详细了解如何授予角色,请参阅管理访问权限。
-
查看和创建信息中心和提醒政策:
Monitoring Editor (
如果您想在 信息中心,然后启用 Service Health API:
显示事件
本部分介绍了如何配置信息中心或可观测性标签页 来显示事件。
配置信息中心以显示事件
本部分介绍如何配置 Google Cloud 控制台的信息中心页面以显示事件。
有关事件类型、问题排查参考和查询的列表 可与日志浏览器或基于日志的提醒政策搭配使用, 请参阅事件类型页面。
控制台
如需在信息中心内显示事件,请执行以下操作:
-
在 Google Cloud 控制台中,转到
信息中心页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 选择要查看的信息中心。
在信息中心的工具栏中,确保
活动切换开关处于开启状态。
如果
事件切换开关未显示,则 信息中心无法显示事件。
点击选择事件类型,选择您希望在事件发生后 信息中心显示,然后执行以下任一操作:
如果您正在查看自定义信息中心,并希望保存事件类型 所选内容,然后点击固定所选内容。如果您已停用自动保存功能 ,然后转到数字面板的工具栏 点击保存。
固定所选内容时,您将修改 信息中心。因此,重新打开信息中心后,您的选择 且信息中心会显示 事件类型。
否则,请点击确定。
在更新要显示的事件类型列表后 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 创建和管理信息中心以及 示例:在信息中心内启用事件。
配置可观测性标签页以显示事件
本部分介绍如何配置可观测性 以显示事件。某些服务(比如 Compute Engine) Google Kubernetes Engine,提供一个可观测性标签页,用于显示 指标和日志数据。
控制台
如需将可观测性标签页配置为显示事件,请执行以下操作:
前往某项服务或产品的可观测性标签页。
例如,您可以转到 Kubernetes 集群页面,然后 选择可观测性标签页。同样,您可以前往 Kubernetes 工作负载页面,或者 虚拟机实例,然后选择可观测性标签页。
确保将信息中心菜单设置为预定义。 事件无法在自定义信息中心内显示。
在工具栏中,点击 event_available Select Events。 然后完成对话框
在您更新要显示的事件列表后,系统会向 检索事件数据,然后更新信息中心。
当 event_available Select Events 按钮未显示时 但无法将该标签页配置为显示事件。
API
不可用。
查看活动详情
在查看显示事件注释的图表时 您可以利用提示中提供的链接 信息。
如要查看特定活动的详细信息,请点击查看。
通过查看按钮打开的 Google Cloud 控制台页面取决于 事件类型。 例如,对于正常运行时间检查事件, 点击此按钮可打开拨测信息中心对于其他 事件类型,则日志浏览器可能会打开。
创建提醒政策
当通过分析 需要通过 Google Cloud 项目中的 Cloud Logging 接收器, 可在这些事件发生时收到通知, 配置基于日志的提醒。基于日志的提醒政策查询 即时更新日志当查询返回非空值时, 从而创建突发事件并发送通知。
控制台
如需创建基于日志的提醒,请执行以下操作:
如果您尚未配置通知渠道,请执行以下操作:
-
在 Google Cloud 控制台中,转到 notifications 提醒页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 点击 Edit notification channel。
- 转到您要配置的通知渠道类型。 点击新增,然后完成对话框。
-
-
在 Google Cloud 控制台中,转到 Logs Explorer 页面。
如果您使用搜索栏查找此页面,请选择子标题为 Logging 的结果。
在工具栏中,选择创建提醒。
输入提醒政策的名称,然后点击下一步。
在定义要发出提醒的日志条目部分, 输入查询,或更新从 Query 窗格复制的查询 (当您选择创建提醒时)。
对于每种事件类型,事件类型页面都列出了 适合在基于日志的提醒政策中使用的查询。
完整填写对话框,然后点击保存。
API
如需使用 Cloud Monitoring API 创建基于日志的提醒政策, 执行以下操作:
确定要包含在 提醒政策。对于每种事件类型, 事件类型页面列出了 适合在基于日志的提醒政策中使用的查询。
创建包含提醒表示法的 JSON 文件 政策。有关此步骤和示例的详情,请参阅 设计提醒政策。
调用 alertPolicies.create API 方法。 例如,您可以向
gcloud alpha monitoring policies create
命令。
隐藏事件
控制台
若要隐藏所有事件,请在信息中心工具栏中执行以下操作: 确保将 toggle_off 事件切换开关关闭。
若要隐藏一种类型的事件,请将该事件类型对应的切换开关设置为“关闭” 排名。
API
要在自定义信息中心内隐藏一种类型的事件,请找到
EventAnnotation
对象:
然后将 enabled
字段设置为 false
。
如需详细了解如何使用 Cloud Monitoring API,请参阅 通过 API 创建和管理信息中心。