本文档介绍了用于实现 OpenTelemetry OTLP 协议的 Telemetry (OTLP) API。此 API 旨在与使用某个 OpenTelemetry SDK 进行插桩处理的应用搭配使用。
为什么应使用 Telemetry API
Telemetry API 支持注入 OTLP 格式的跟踪记录数据。使用 Telemetry API 时,您的数据会以 OTLP 格式存储,而不会转换为专有格式,并且需遵循针对 Telemetry API 的限制。这些限制通常比针对 Cloud Trace API 的限制更宽松。最后,您的插桩不依赖于特定于 Google Cloud的导出器。
OpenTelemetry 是一个受 Google Cloud支持的开源项目,配备 Google Cloud工程师来确保支持注入和直观呈现跟踪记录数据。
何时使用 Telemetry API
在对应用进行插桩处理以将跟踪记录数据发送到Google Cloud 项目时,我们建议您执行以下操作之一:
- 使用将 OTLP 写入收集器的导出器,收集器随后会将跟踪记录数据发送到 Telemetry API。
- 使用受 OpenTelemetry 库支持的进程中 OTLP 导出器,该库会将遥测数据发送到 Telemetry API。没有具有此配置的收集器。
如需了解如何使用 Telemetry API,请参阅从 Cloud Trace 导出器迁移到 OTLP 端点。
在何处查看注入的数据
您可以使用 Trace 探索器页面查看通过 Telemetry API 注入的跟踪记录数据。如需了解如何查看跟踪记录数据,请参阅查找和探索跟踪记录。
通过 Telemetry API 注入的跟踪记录数据无法在旧版 Trace 探索器页面中使用。如需了解详情,请参阅旧版 Trace 探索器:已知问题。
身份验证
导出器必须获得授权,才能将数据发送到您的 Google Cloud 项目。例如,您可以通过向应用添加特定于语言的 Google Auth 库,来使用 Google Cloud应用默认凭证 (ADC) 配置导出器。如需了解详情和查看示例代码,请参阅配置身份验证。
VPC Service Controls 支持
Telemetry API 服务(服务名称为 telemetry.googleapis.com
)是 VPC Service Controls 支持的一项服务。您为 Telemetry API 服务创建的任何 VPC Service Controls 限制仅适用于该服务。这些限制不适用于任何其他服务(包括也可以注入跟踪记录数据的 cloudtrace.googleapis.com
等服务)。
详情请参阅以下内容: