本页面将指导您完成以下步骤:
- 安装 OpenTelemetry 软件包。
- 配置应用以将 span 导出到 Cloud Trace。
- 配置您的平台。
如需了解版本信息,请参阅以下内容:
如需了解 OpenTelemetry 参考内容,请参阅以下内容:
有关适用于 C++ 的 OpenTelemetry 的最新详细信息以及其他文档和示例,请参阅 OpenTelemetry。
准备工作
Enable the Cloud Trace API.
安装 OpenTelemetry 软件包
- 设置 C++ 开发环境。
- 安装 Google Cloud C++ OpenTelemetry 导出器库。如需了解安装信息,请参阅 OpenTelemetry 快速入门。
配置将 span 导出到 Cloud Trace
如需配置轨迹数据导出,请在 main()
方法中调用 google::cloud::otel::ConfigureBasicTracing(...)
方法:
project_id
字段是您要存储轨迹的 Google Cloud 项目。
方法 ConfigureBasicTracing(...)
会实例化实现 Cloud Trace 导出器的 TracerProvider
对象。如果调用 ConfigureBasicTracing(...)
返回的对象超出作用域,则会恢复先前的 TracerProvider
对象(如果存在)。
配置采样率
应用可能会生成大量轨迹数据。以下示例展示了如何配置采样率:
使用自定义 TracerProvider
导出到 Cloud Trace
您可能有需要自定义 TracerProvider
对象的用例。对于
例如,如果你想同时使用多个导出器,则需要
以创建自定义 TracerProvider
对象。在以下情况下,您可以直接使用 Cloud Trace 导出器:
对您自己的应用进行插桩
如需了解如何配置应用以捕获跟踪记录 span,请参阅 OpenTelemetry 跟踪记录。本页面介绍了如何进行以下所有操作:
- 创建 span
- 创建嵌套的 Span
- 设置 span 属性
- 使用事件创建 span
- 创建包含链接的 span
示例应用
有关示例应用,请参阅 参阅快速入门。
配置平台
您可以在 Google Cloud 和其他平台上使用 Cloud Trace。
在 Google Cloud 上运行
当您的应用在 Google Cloud 上运行时,您无需向客户端库提供服务账号形式的身份验证凭据。不过,您需要确保 您的 Google Cloud 平台 Cloud Trace API 访问权限范围 。
如需查看受支持的 Google Cloud 环境的列表,请参阅环境支持。
对于以下配置,默认的访问权限范围设置会启用 Cloud Trace API:
- App Engine 柔性环境
App Engine 标准环境
Google Kubernetes Engine (GKE)
Compute Engine
Cloud Run
如果您使用自定义访问权限范围,则必须确保已启用 Cloud Trace API 访问权限范围:
如需了解如何使用 Google Cloud 控制台为您的环境配置访问权限范围,请参阅配置 Google Cloud 项目。
对于
gcloud
用户,请使用--scopes
标志指定访问权限范围,并添加trace.append
Cloud Trace API 访问权限范围。例如,如需创建仅启用了 Cloud Trace API 的 GKE 集群,请执行以下操作:gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append
在本地和其他位置运行
如果您的应用在 Google Cloud 之外运行,则必须向客户端库提供服务账号形式的身份验证凭据。该服务账号必须包含 Cloud Trace Agent 角色。如需查看说明,请参阅创建服务账号。
Google Cloud 客户端库会使用应用默认凭据 (ADC) 查找应用的凭据。
您可以通过以下三种方式之一提供这些凭据:
运行
gcloud auth application-default login
将服务账号放置在操作系统的默认路径中。以下列出了 Windows 和 Linux 的默认路径:
Windows:
%APPDATA%/gcloud/application_default_credentials.json
Linux:
$HOME/.config/gcloud/application_default_credentials.json
将
GOOGLE_APPLICATION_CREDENTIALS
环境变量设置为服务账号的路径:
Linux/macOS
export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
Windows
set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"
查看跟踪记录
在 Google Cloud 控制台中,转到 Trace 探索器页面:
您也可以使用搜索栏查找此页面。
问题排查
如需了解如何排查 Cloud Trace 的问题,请转到“问题排查”页面。
如需调试 C++ Cloud Trace 导出器,请参阅参考文档的问题排查部分。
资源
- https://opentelemetry.io/
- open-telemetry/opentelemetry-cpp GitHub 代码库
- google-cloud-cpp OpenTelemetry 导出器库 GitHub 代码库。