本文档介绍了如何配置 Google Cloud Observability,以便查看已注册到 App Hub 的应用的遥测数据。您可以先部署应用,然后将其注册到 App Hub;也可以使用应用设计中心部署应用。应用监控功能可帮助您了解应用、服务和工作负载的性能。
准备工作
确定要配置其可观测性范围的项目。此项目是您的 App Hub 宿主项目,或者已启用应用的文件夹的管理项目。例如,如果文件夹的显示名称为
My Folder
,则管理项目的显示名称为My Folder-mp
。确保您拥有配置可观测性范围所需的 Identity and Access Management (IAM) 角色。所需的 IAM 角色取决于您是否计划创建汇总接收器,以便集中存储日志数据。
配置接收器和镜重
如需获得配置可观测性范围和创建汇总日志接收器所需的权限,请让您的管理员为您授予组织的 Organization Administrator (
roles/resourcemanager.organizationAdmin
) IAM 角色。 如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。仅配置镜重
如需获得配置可观测性范围所需的权限,请让您的管理员为您授予以下 IAM 角色:
-
App Hub 宿主项目或已启用应用的文件夹的管理项目中的 Observability Editor (
roles/observability.editor
) -
App Hub 宿主项目或启用了应用的文件夹的管理项目中的 Logs Configuration Writer (
roles/logging.configWriter
) -
App Hub 宿主项目或启用了应用的文件夹的管理项目的 Monitoring Admin (
roles/monitoring.admin
),以及要添加到指标范围的每个项目 -
App Hub 托管项目或启用了应用的文件夹的管理项目中的 Cloud Trace User (
roles/cloudtrace.user
) -
App Hub 宿主项目或启用了应用的文件夹的管理项目中的 App Hub 查看者 (
roles/apphub.viewer
)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
-
App Hub 宿主项目或已启用应用的文件夹的管理项目中的 Observability Editor (
配置可观测性范围
可观测性范围用于控制 Explorer 和信息中心页面搜索要显示的数据的方式。每个 Google Cloud 项目都包含一个可观测性范围。您无法直接配置项目的可观测性范围。而是为您的项目配置以下内容:
默认日志范围
配置此范围,以便在您打开 Logs Explorer 页面或查看信息中心时,系统会显示应用的日志数据。确保此范围列出了存储应用日志数据的项目和日志视图。
指标范围
配置此范围,以便图表(例如您使用 Metrics Explorer 页面创建的图表)和提醒政策可以显示或监控应用的指标数据。确保此范围列出了存储应用指标数据的项目。
默认轨迹范围
配置此范围,以便在您打开 Trace 探索器页面时,系统会显示应用的轨迹数据。确保此范围列出了存储应用轨迹数据的项目。
本部分的其余内容将介绍如何配置这些镜重。
配置和设置默认日志范围
执行下列其中一项操作:
如果您有一个组织级汇总接收器,用于将组织中的所有日志数据路由到集中式日志存储分区,我们建议您执行以下操作:
如果您使用的是启用了应用的文件夹,并且没有组织级别的汇总接收器或嵌套文件夹,我们建议您执行以下操作:
为已启用应用的文件夹创建拦截汇总接收器,并将这些日志路由到您将用于查看日志的项目的
_Default
日志存储分区。在启用了应用的文件夹的管理项目中,确保将名为
_Default
的日志范围设置为默认日志范围。名为_Default
的范围会在项目的_Default
日志存储分区(即应用的集中式存储位置)中列出_AllLogs
视图。
如果您不使用汇总接收器,则对于 App Hub 宿主项目或启用了应用的文件夹的管理项目,请配置默认日志范围以列出应用日志数据的存储位置。我们建议您在存储日志数据的日志存储分区中添加日志视图,而不是将项目添加到日志范围。
配置指标范围
确保您的 App Hub 宿主项目或启用了应用的文件夹的管理项目的指标范围列出了存储应用指标数据的所有项目:
对于启用了应用的文件夹,Google Cloud Observability 会尝试将启用了应用的文件夹中的项目列表与指标范围中的项目列表同步。例如,如果您将项目添加到启用了应用的文件夹,系统会发出命令将该项目添加到指标范围。
如果启用了应用的文件夹中的项目数量不超过指标范围配额(默认为每个指标范围 375 个项目),则 Google Cloud Observability 可以让指标范围中的项目列表与启用了应用的文件夹中的项目列表保持同步。例如,假设每个指标范围的配额为 375 个项目。如果启用了应用的文件夹包含 100 个项目,则指标范围会列出启用了应用的文件夹中的所有项目。如果您向启用了应用的文件夹添加项目,这些项目也会添加到指标范围中。
如果启用了应用的文件夹中的项目数量超出了指标范围配额,则指标范围中的项目列表将不包含启用了应用的文件夹中的所有项目。例如,假设每个指标范围的配额为 375 个项目,并且您启用了应用的文件夹包含 380 个项目。将 375 个项目添加到指标范围后,配额用尽,尝试添加其余 5 个项目会失败。因此,您的管理项目无法使用部分应用数据。
我们建议您查看指标范围配额的使用情况,并确定您是否需要请求更新配额或手动修改指标范围。如需了解这些步骤,请参阅启用了应用的文件夹的指标范围。
对于 App Hub 宿主项目,您必须配置宿主项目的指标范围。
如果您更改存储指标数据的一组项目,则还必须更新宿主项目的指标范围。
配置和设置默认轨迹范围
执行以下操作:
在 App Hub 宿主项目或启用了应用的文件夹的管理项目中,创建轨迹范围,然后添加用于存储应用轨迹数据的项目。如果您使用的是已启用应用的文件夹,请在该文件夹中添加项目。
将自定义轨迹范围设为默认轨迹范围。
将提醒政策与 App Hub 应用相关联
如需在应用监控的上下文中查看提醒政策,您必须向提醒政策添加应用专用标签,以便将提醒政策与服务或工作负载相关联。这些用户定义的标签也会包含在为政策创建的任何突发事件中。如需详细了解标签,请参阅使用标签为突发事件添加注释。如需查看 App Hub 标签列表,请参阅查看应用遥测数据。
如需使用 Google Cloud 控制台将提醒政策与工作负载或服务相关联,请执行以下操作:
-
在 Google Cloud 控制台中,转到 notifications 提醒页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 在 Google Cloud 控制台的工具栏中,选择您的 App Hub 宿主项目或启用了应用的文件夹的管理项目。
- 找到相应提醒政策,点击 more_vert View more(查看更多),选择 Edit(修改),然后前往Notifications and name(通知和名称)部分。
- 在应用标签部分,选择您的应用,然后选择您的工作负载或服务。
- 点击保存政策。
完成这些步骤后,系统会将具有以下键的标签附加到您的提醒政策。这些标签用于标识您的应用以及您的服务或工作负载:
apphub_application_location
apphub_application_id
apphub_service_id
或apphub_workload_id
您还可以使用 Google Cloud CLI、Terraform 或 Cloud Monitoring API 向提醒政策添加用户标签。不过,您必须使用上例中显示的标签键。详情请参阅以下内容:
授予访问权限
IAM 用于管理对日志、指标和跟踪记录数据的访问权限。本部分汇总了您可能需要向主账号授予的角色:
对 App Hub 宿主项目或已启用应用的文件夹的管理项目的默认日志范围中列出的日志视图的 Logs View Accessor (
roles/logging.viewAccessor
)。如需详细了解如何授予对日志视图的访问权限,请参阅控制对日志视图的访问权限。App Hub 托管项目或启用了应用的文件夹的管理项目上的 Logs Viewer (
roles/logging.viewer
),以及其默认日志范围中列出的任何其他项目。此角色会授予对_Default
日志存储分区中大多数日志条目的访问权限。如需了解详情,请参阅日志记录角色。App Hub 宿主项目或已启用应用的文件夹的管理项目中的 Monitoring Editor 角色 (
roles/monitoring.editor
)。对于不需要创建提醒政策的主账号,不妨考虑授予 Monitoring Viewer 角色 (roles/monitoring.viewer
)。App Hub 托管项目或启用了应用的文件夹的管理项目以及其默认跟踪范围中列出的项目上的 Cloud Trace User (
roles/cloudtrace.user
)。App Hub 宿主项目或启用了应用的文件夹的管理项目中的 App Hub Viewer (
roles/apphub.view
)。