本文档介绍了如何创建和管理跟踪范围,以便跟踪记录探索器页面查找您要查看或分析的跟踪 span。如果您只想查看和分析源自 Google Cloud 项目的 span,则无需配置任何跟踪范围。不过,如果您的轨迹数据存储在多个项目中(在使用微服务架构时可能会出现这种情况),那么您需要执行一些配置活动,才能查看单个 Google Cloud 项目中的所有 span。
本文档未介绍如何查看轨迹和 span。如需了解该主题,请参阅查找和探索轨迹。
此功能仅适用于 Google Cloud 项目。对于 App Hub 配置,请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
跟踪记录范围简介
跟踪记录范围是列出一组 Google Cloud 项目的项目级永久性资源。您可以将 Trace 探索器页面配置为按跟踪记录范围进行搜索,这意味着该页面会搜索所选范围中列出的项目。您对搜索的项目所拥有的 Identity and Access Management (IAM) 角色以及时间范围设置决定了从存储中提取哪些数据,然后显示哪些数据。
创建 Google Cloud 项目时,系统会创建一个名为 _Default
的轨迹范围。此范围仅包括 Google Cloud 项目。您无法向此范围添加项目或删除此范围。
您可以创建跟踪记录范围,还可以修改和删除自己创建的任何跟踪记录范围。如果您的服务将 span 数据写入多个 Google Cloud 项目,则需要创建跟踪记录范围。
除非您使用包含跟踪记录范围或跟踪记录 ID 和 span ID 的网址打开 Trace 探索器页面,否则该页面会在默认跟踪记录范围中列出的Google Cloud 项目中搜索跟踪记录数据。创建项目时,系统会将名为 _Default
的跟踪范围设置为默认跟踪范围。不过,您可以选择其他轨迹范围作为默认轨迹范围。
App Hub 应用和轨迹范围
您的 App Hub 应用可能会将跟踪数据写入多个项目。如需获取此数据的汇总视图,请创建一个跟踪记录范围,将其配置为列出存储跟踪记录数据的所有项目,然后将其配置为默认跟踪记录范围。完成这些步骤后,Trace 探索器页面会自动显示应用写入的数据,即使这些数据存储在不同的项目中也是如此。
在您要查看日志数据的项目中创建自定义轨迹范围。此项目是您的 App Hub 宿主项目或已启用应用的文件夹的管理项目。例如,如果文件夹的显示名称为 My Folder
,则管理项目的显示名称为 My Folder-mp
。
准备工作
如需获得创建和查看跟踪记录范围所需的权限,请让您的管理员为您授予项目的 Cloud Trace User (roles/cloudtrace.user
) IAM 角色。
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
此预定义角色包含创建和查看跟踪范围所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
如需创建和查看轨迹范围,需要具备以下权限:
-
创建和管理跟踪范围:
cloudtrace.traceScopes.{create, delete, get, list, update}
需要其他权限才能设置默认轨迹范围。 本文档的配置默认跟踪记录范围部分介绍了这些权限。
列出跟踪记录范围
控制台
如需列出跟踪范围,请执行以下操作:
创建跟踪记录范围
Trace 探索器页面显示的 span 取决于搜索的项目、您在这些项目中的 IAM 角色、时间范围设置以及您应用的过滤条件。
您可以为每个项目创建 100 个跟踪记录范围。一个跟踪记录范围最多可包含 20 个项目。
控制台
如需创建轨迹范围,请执行以下操作:
-
在 Google Cloud 控制台中,前往 settings 设置页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 在 Google Cloud 控制台的工具栏中,选择您的 Google Cloud 项目。对于 App Hub 配置,请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
- 选择跟踪记录范围标签页,然后点击创建跟踪记录范围。
点击添加项目,然后完成对话框。
添加项目后,该项目中存储的 span 会纳入跟踪范围。如果您不知道要在范围中包含哪些项目,可以使用旧版跟踪记录探索器页面来帮助您确定。如需了解详情,请参阅本文档的迁移到轨迹范围部分。
在为轨迹范围命名部分,输入您希望在轨迹范围标签页上显示的名称和说明。
轨迹范围的名称无法修改,并且在项目中必须是唯一的。
点击创建轨迹范围。
迁移到跟踪范围
Trace 探索器页面要求您指定Google Cloud 要搜索跟踪记录数据的项目,这与旧版 Trace 探索器页面的行为有所不同。旧版 Trace 探索器页面会搜索组织中的所有项目。由于存在这些差异,Trace 探索器页面可能不会显示旧版 Trace 探索器页面显示的 span。
您可以使用旧版 Trace 探索器页面的跟踪记录详情窗格部分,帮助您编制存储跟踪记录数据的Google Cloud 项目列表:
前往旧版跟踪记录探索器页面:
在 Google Cloud 控制台的工具栏中,选择您的 Google Cloud 项目。对于 App Hub 配置,请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
选择轨迹。
您可以尝试以下操作:
- 通过在跟踪记录 ID 字段中输入跟踪记录 ID 来查看跟踪记录。
- 添加过滤条件。
在跟踪记录详情窗格中,选择相应跟踪记录,然后前往项目标签页。
此标签页列出了存储轨迹跨度的项目。
如需创建包含所列项目的轨迹范围,请前往项目标签页的工具栏,选择使用这些项目创建范围,然后完成对话框。
重复执行上述步骤,直到您整理出项目列表。
在编制项目列表后,请创建轨迹范围。 您还可以将其设置为默认跟踪范围。
修改或删除轨迹范围
您无法删除或修改名为 _Default
的轨迹范围。您可以修改或删除所有其他轨迹范围。
控制台
如需修改或删除轨迹范围,请执行以下操作:
配置默认跟踪范围
Trace 探索器页面打开时,会在默认跟踪记录范围中列出的项目中搜索跟踪记录数据。如果无法访问该轨迹范围,则会在您的项目中搜索轨迹数据。
创建项目时,系统会创建名为 _Default
的轨迹范围,并将其指定为默认轨迹范围。不过,您可以创建自己的轨迹范围并将其指定为默认轨迹范围。
准备工作
-
Enable the Observability API.
在启用此 API 之前,确保选择正确的项目。对于 App Hub 配置,请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
-
如需获得创建和查看跟踪范围以及设置默认跟踪范围所需的权限,请让您的管理员为您授予项目的以下 IAM 角色:
-
Cloud Trace User (
roles/cloudtrace.user
) -
Observability Editor (
roles/observability.editor
)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
这些预定义角色包含创建和查看轨迹范围以及设置默认轨迹范围所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
您需要具备以下权限才能创建和查看轨迹范围以及设置默认轨迹范围:
-
创建和管理跟踪范围:
cloudtrace.traceScopes.{create, delete, get, list, update}
-
设置默认跟踪记录范围:
observability.scopes.{get, update}
-
Cloud Trace User (
设置默认范围
控制台
如需设置默认跟踪记录范围,请执行以下操作:
限制
Cloud Trace API 或 Google Cloud CLI 不支持创建或管理跟踪范围。
跟踪范围的限制
跟踪范围的限制 | 值 |
---|---|
每个项目的跟踪范围数量上限 | 100 |
每个跟踪记录范围的项目数量上限 | 20 |
后续步骤
Cloud Logging 和 Cloud Monitoring 包含类似的结构,可让您控制可以查看或监控的日志数据或指标数据。如需了解这些范围,请参阅以下文档: