OpenTelemetry支持tracecontext、baggage、b3、b3multi、jaeger等多种透传格式,不同透传格式会在HTTP请求中设置不同格式的Header。本文为您介绍如何设置OpenTelemetry的透传格式。
OpenTelemetry支持的透传格式
默认情况下,OpenTelemetry使用的是tracecontext和baggage。
透传格式名称 | 格式 | 备注 |
tracecontext | traceparent : {version}-{trace-id}-{parent-id}-{trace-flags} | |
baggage | - | |
b3 | b3: {TraceId}-{SpanId}-{SamplingState}-{ParentSpanId} | |
b3multi | X-B3-TraceId: {TraceId} X-B3-SpanId: {SpanId} X-B3-ParentSpanId: {ParentSpanId} X-B3-Sampled: {SamplingState} | |
jaeger | uber-trace-id : {trace-id}:{span-id}:{parent-span-id}:{flags} | |
xray | - | - |
ottrace | - | - |
none | - | - |
设置透传格式
在启动应用时,有两种方式可以设置OpenTelemetry TraceId的透传格式:
使用otel.propagators参数:
-Dotel.propagators=tracecontext,baggage支持同时指定多种格式,使用英文半角逗号(,)分隔。
-javaagent:/path/to/opentelemetry-javaagent.jar -Dotel.resource.attributes=service.name=<service-name> -Dotel.exporter.otlp.headers=Authentication=<token> -Dotel.exporter.otlp.endpoint=<endpoint> -Dotel.metrics.exporter=none -Dotel.propagators=tracecontext,baggage,b3
设置OTEL_PROPAGATORS环境变量,然后运行程序。
支持同时指定多种格式,使用英文半角逗号(,)分隔。
export OTEL_PROPAGATORS="b3"
指定多种透传格式时的行为
指定多种透传格式(例如 tracecontext,baggage,b3)时,传播器(Propagator)每次请求都会按所列的全部格式注入和提取 Header。需注意以下事项:
默认格式:
tracecontext和baggage是 W3C 标准,大多数主流可观测平台均支持。除非服务需要使用其他格式,否则建议优先使用这两种格式。兼容 Zipkin:对于基于 Zipkin 的链路追踪系统,请使用
b3(单个 Header)或b3multi(多个独立 Header)。兼容 Jaeger:对于使用 Jaeger 客户端埋点的服务,请使用
jaeger。禁用透传:将透传格式设置为
none,即可停止注入和提取链路上下文 Header。