OpenTelemetry规范解读：上下文传播的分层架构设计-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00298/article/details/148551787

OpenTelemetry规范解读：上下文传播的分层架构设计

opentelemetry-specification Specifications for OpenTelemetry 项目地址: https://gitcode.com/gh_mirrors/op/opentelemetry-specification

引言

在分布式系统中，如何有效地传递上下文信息是一个关键问题。OpenTelemetry作为新一代的分布式追踪和指标收集框架，提出了一套创新的上下文传播机制。本文将深入解析OpenTelemetry规范中的上下文传播分层架构设计，帮助开发者理解其核心思想和实现原理。

设计动机

OpenTelemetry的上下文传播设计主要解决两个核心问题：

关注点分离：
- 通过清晰的包结构设计降低学习曲线，开发者可以单独理解上下文传播机制而不必先掌握完整的可观测性系统
- 支持多种类型的上下文传播机制，每种机制可以有自己的规则（例如TraceContext可能支持采样，而CorrelationContext则不需要）
- 允许可观测性和上下文传播系统拥有不同的默认实现
可扩展性：
- 上下文传播机制可以独立使用，不强制依赖可观测性系统
- 支持开发者创建新的上下文传播应用场景，如A/B测试、身份验证、网络切换等

分层架构设计

OpenTelemetry采用了面向切面编程(AOP)的思想，并将其扩展到分布式系统场景。整个架构分为两层：

上下文传播架构图

上层：横切关注点

这些关注点会"横切"程序的多个抽象层次，主要包括：

可观测性API：
- 分布式追踪是最典型的横切关注点
- 追踪代码与业务代码交织，连接了原本独立的代码模块
- 需要事务级的上下文传播才能正确执行
关联API(Correlations API)：
- 基于W3C Baggage规范实现
- 主要用于在一个服务中为观测事件建立索引，这些属性由同一事务中的前驱服务提供
- 帮助建立事件间的因果关系（如特定浏览器版本与图像处理服务失败间的关联）

底层：上下文传播

所有上层关注点共享的底层机制，用于在分布式事务的生命周期中存储状态和访问数据。

核心API设计

上下文API

跨切面关注点通过共享的上下文对象访问进程内数据，每个关注点使用自己命名空间下的键。

// 创建不可猜测的键，确保数据访问安全
CreateKey(name) -> key

// 获取上下文中的值
GetValue(context, key) -> value

// 设置上下文中的值（返回新上下文）
SetValue(context, key, value) -> context

// 移除上下文中的值
RemoveValue(context, key) -> context

可选：自动化上下文管理

某些语言支持自动关联程序执行上下文：

// 获取当前执行上下文
GetCurrent() -> context

// 设置当前执行上下文
SetCurrent(context)

传播API

跨切面关注点通过传播器(propagator)将状态发送到下一个进程。

// 从HTTP头中提取上下文
Extract(context, []http_extractor, headers) -> context

// 将上下文注入HTTP头
Inject(context, []http_injector, headers) -> headers

// HTTP提取器接口
HTTP_Extractor(context, headers) -> context

// HTTP注入器接口
HTTP_Injector(context, headers) -> headers

可选：全局传播器

为方便使用，提供了全局注入器和提取器：

GetExtractors() -> []http_extractor
SetExtractors([]http_extractor)
GetInjectors() -> []http_injector
SetInjectors([]http_injector)

实际应用示例

考虑一个服务调用链：客户端 → 服务A → 服务B/服务C。服务A需要根据客户端版本决定调用哪个后端服务，同时需要追踪整个系统性能。

全局初始化

func InitializeOpentelemetry() {
  // 创建关联和追踪的传播器
  bagExtract, bagInject = Correlations::HTTPPropagator()
  traceExtract, traceInject = Tracer::B3Propagator()
  
  // 设置全局传播器
  Propagation::SetExtractors(bagExtract, traceExtract)
  Propagation::SetInjectors(bagInject, traceInject)
}

请求处理

func ServeRequest(context, request, project) -> (context) {
  // 从HTTP头提取上下文
  extractors = Propagation::GetExtractors()
  context = Propagation::Extract(context, extractors, request.Headers)

  // 启动新span
  context = Tracer::StartSpan(context, [span options])
  
  // 获取客户端版本
  version = Correlations::GetCorrelation(context, "client-version")

  // 根据版本路由
  switch( version ){
    case "v1.0": data, context = FetchDataFromServiceB(context)
    case "v2.0": data, context = FetchDataFromServiceC(context)
  }

  context = request.Response(context, data)
  Tracer::EndSpan(context)
  return context
}

传播器实现示例

B3格式的追踪上下文传播器实现：

func B3Extractor(context, headers) -> (context) {
  context = Context::SetValue(context, "trace.parentTraceID", headers["X-B3-TraceId"])
  context = Context::SetValue(context, "trace.parentSpanID", headers["X-B3-SpanId"])
  return context
}

func B3Injector(context, headers) -> (headers) {
  headers["X-B3-TraceId"] = Context::GetValue(context, "trace.parentTraceID")
  headers["X-B3-SpanId"] = Context::GetValue(context, "trace.parentSpanID")
  return headers
}