跟踪上下文

本文档简要介绍了上下文(指状态)和上下文传播(指将状态信息传递给子操作)。对于分布式跟踪,必须将跟踪 ID 和正在处理的 span 的 ID 传递给子操作。

子操作会创建一个 span 并设置以下字段:

  • Span ID:子操作的唯一标识符。 如果同一操作执行多次,则该操作会有多个 span,每个 span 都有一个唯一标识符。
  • 跟踪 ID:相应总体操作所发生的端到端操作的唯一标识符。此字段的值由父级提供。
  • 父级 span ID:父级 span 的唯一标识符。 此字段的值由父级提供。 对于根 span,此 ID 为 null

借助跟踪记录 ID、span ID 和父 span ID 字段的值,分布式跟踪记录系统可以正确地将 span 链接在一起,从而形成跟踪记录。 例如,Cloud Trace 将 span 存储在代码库中,并使用这些 ID 字段来标识哪些 span 构成轨迹。

上下文可能包含对分布式跟踪有用的其他状态信息。例如,万维网联盟 (W3C) 标准包含有关父 span 是否已采样的信息。

上下文传播协议

以下部分介绍了特定请求协议如何传播上下文。

HTTP 请求

对于 HTTP 请求,上下文传播通常通过 HTTP 标头(例如 traceparenttracestate 标头)完成,这些标头已由 W3C 标准化。支持跟踪记录上下文传播的Google Cloud 服务通常同时支持 traceparent旧版 X-Cloud-Trace-Context 标头

我们建议您尽可能在应用中使用 traceparent 标头。您的应用可能需要使用旧版 X-Cloud-Trace-Context 标头,或者可能需要支持以其他格式接收跟踪上下文。

如果您的应用仅支持 X-Cloud-Trace-Context 标头,我们建议您更新应用以支持 traceparent 标头并优先使用该标头。您的应用可以继续使用 X-Cloud-Trace-Context 标头作为后备解决方案。

下表总结了这两个标头之间的一些显著区别:

属性 traceparent
标头
X-Cloud-Trace-Context
标头
分隔符 连字符 (-) 正斜线 (/) 和分号 (;)
Span ID
表示法
十六进制 十进制

旧版 X-Cloud-Trace-Context 标头

Google Cloud 使用的 X-Cloud-Trace-Context 标头早于 W3C 规范。为了实现向后兼容性,某些 Google Cloud 服务会继续接受、生成和传播 X-Cloud-Trace-Context 标头。不过,这些系统很可能也支持 traceparent 标头。

X-Cloud-Trace-Context 标头采用以下格式:

X-Cloud-Trace-Context: TRACE_ID/SPAN_ID;o=OPTIONS

标头的字段定义如下:

  • TRACE_ID 是一个 32 个字符的十六进制值,表示一个 128 位的数字。
  • SPAN_ID 是无符号 span ID 的 64 位十进制表示法。
  • OPTIONS 支持 0(未对父级进行抽样)和 1(已对父级进行抽样)。

gRPC 请求

对于 gRPC 请求,上下文传播是通过 gRPC 元数据实现的,而 gRPC 元数据是在 HTTP 标头的基础上实现的。gRPC 应用可能会使用 traceparent 标头或名为 grpc-trace-bin 的元数据上下文键。

对于您拥有的组件,我们建议您使用 traceparent 标头。

Google Cloud 服务的上下文传播

Google Cloud 服务可能会在请求处理中充当发起者或中介。例如,以下服务已知会参与处理请求:

对跟踪上下文启动和传播的支持取决于特定的 Google Cloud 服务。如需请求 Google Cloud 服务添加对上下文传播的支持,请使用 Google 问题跟踪器

应用中的上下文传播

某些插桩库(例如 OpenTelemetry)可以传播包含跟踪所需数据的 context 对象。如需查看支持跟踪的 OpenTelemetry 库的列表,请参阅语言 API 和 SDK

如果您依赖于某个开源库,请确定上下文传播是否可用以及是否需要进行配置。例如,如果您使用 OpenTelemetry 对 Go 应用进行插桩,则您的应用应调用 SetTextMapPropagator,该函数会将上下文配置为使用 W3C traceparent 格式。如需查看示例,请参阅 Go 插桩示例

如果没有合适的插桩库,您必须确保应用将跟踪上下文传播到子操作。

后续步骤