欢迎来到雄杰鑫电商资讯网
技术教程

OpenTelemetry Java：实现跨服务Span上下文传播

聖光之護 次阅读

在opentelemetry java中，无法直接通过span id获取span对象。为了在分布式系统中建立父子span关系，应利用opentelemetry的上下文传播机制。通过`textmappropagator`将当前span的上下文注入到请求头等载体中，然后在接收端提取该上下文并作为新span的父级，从而正确地连接分布式跟踪链。

理解OpenTelemetry中的Span关联

在分布式系统中，服务间的调用需要建立明确的跟踪关系，即父子Span关系。OpenTelemetry通过Span来表示单个操作，并通过Context来传递这些Span之间的关系。一个常见的问题是，当一个服务接收到一个远程调用的请求，并且只知道父Span的ID时，是否能直接通过这个ID获取到父Span对象并将其设置为当前Span的父级。

答案是：不能直接通过Span ID获取Span对象。 OpenTelemetry的设计理念是轻量级和分布式，Span ID只是一个标识符，用于在分布式跟踪系统中唯一标识一个Span。它并非一个在内存中可直接引用的对象句柄，尤其是在跨进程或跨线程的场景下。一个Span对象通常只在其创建和活跃的本地进程中存在。

为了解决跨服务或跨进程的Span关联问题，OpenTelemetry引入了“上下文传播（Context Propagation）”机制。

核心概念：上下文传播（Context Propagation）

上下文传播是OpenTelemetry中实现分布式跟踪的关键。它允许将当前操作的跟踪上下文（包括Trace ID、Span ID以及其他跟踪状态）从一个服务传递到另一个服务，或者从一个异步操作传递到另一个。

主要涉及以下两个核心组件：

  1. Context对象：OpenTelemetry的Context是一个不可变的数据结构，用于在代码执行路径中传递跟踪和度量信息。它包含了当前活动的Span以及其他与跟踪相关的状态。
  2. TextMapPropagator：这是一个接口，定义了如何将Context信息“注入”（inject）到请求头、消息队列元数据等文本格式的载体中，以及如何从这些载体中“提取”（extract）Context信息。OpenTelemetry支持多种传播协议，如W3C Trace Context、B3等。

实践指南：实现跨服务Span上下文传播

以下是如何在Java中使用OpenTelemetry实现上下文传播的详细步骤。

1. 发送方：注入上下文

当服务A调用服务B时，服务A需要将当前活动的Span的上下文注入到出站请求中。

示例代码：

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.api.baggage.Baggage;
import io.opentelemetry.context.propagation.TextMapSetter;

import java.util.HashMap;
import java.util.Map;

public class SenderService {

    private final OpenTelemetry openTelemetry;
    private final Tracer tracer;

    public SenderService(OpenTelemetry openTelemetry) {
        this.openTelemetry = openTelemetry;
        this.tracer = openTelemetry.getTracer("SenderService");
    }

    public Map makeRemoteCall(String serviceName) {
        // 1. 创建一个Span，并使其成为当前活动的Span
        Span span = tracer.spanBuilder("sendTo" + serviceName)
                .startSpan();

        Map headers = new HashMap<>(); // 模拟HTTP请求头

        try (Scope scope = span.makeCurrent()) {
            // 2. 获取当前Context，其中包含活动的Span
     
       Context currentContext = Context.current();

            // 3. 使用TextMapPropagator将Context注入到headers中
            openTelemetry.getPropagators().getTextMapPropagator().inject(
                    currentContext,
                    headers,
                    new TextMapSetter>() {
                        @Override
                        public void set(Map carrier, String key, String value) {
                            carrier.put(key, value);
                        }
                    });

            System.out.println("Sender Span ID: " + span.getSpanContext().getSpanId());
            System.out.println("Injected headers: " + headers);

            // 模拟执行一些业务逻辑
            // ...

        } finally {
            span.end(); // 结束Span
        }
        return headers;
    }

    public static void main(String[] args) {
        // 通常OpenTelemetry实例会在应用启动时初始化
        // 这里为了示例方便，简单创建
        OpenTelemetry openTelemetry = OpenTelemetry.noop(); // 实际应用中会使用SDK初始化

        SenderService sender = new SenderService(openTelemetry);
        sender.makeRemoteCall("ReceiverService");
    }
}

在上述代码中：

  • span.makeCurrent()将当前Span设置为活跃Span，并将其放入Context.current()中。
  • openTelemetry.getPropagators().getTextMapPropagator().inject()负责将Context.current()中的跟踪信息（如Trace ID和Span ID）序列化并写入到headers这个载体中。TextMapSetter定义了如何将键值对写入载体。

2. 接收方：提取上下文并创建子Span

当服务B接收到服务A的请求时，它需要从请求中提取上下文，并使用该上下文作为新创建Span的父级。

示例代码：

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.context.propagation.TextMapGetter;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

public class ReceiverService {

    private final OpenTelemetry openTelemetry;
    private final Tracer tracer;

    public ReceiverService(OpenTelemetry openTelemetry) {
        this.openTelemetry = openTelemetry;
        this.tracer = openTelemetry.getTracer("ReceiverService");
    }

    public void processRemoteCall(Map headers) {
        // 1. 从接收到的请求头中提取Context
        Context extractedContext = openTelemetry.getPropagators().getTextMapPropagator().extract(
                Context.current(), // 默认的当前Context，如果不存在父Context，则使用它
                headers,
                new TextMapGetter>() {
                    @Override
                    public Iterable keys(Map carrier) {
                        return carrier.keySet();
                    }

                    @Override
                    public String get(Map carrier, String key) {
                        return carrier.get(key);
                    }
                });

        // 2. 将提取到的Context设置为新Span的父级
        // 注意：这里不是直接传入Span对象，而是传入包含父Span信息的Context
        Span span = tracer.spanBuilder("processRequest")
                .setParent(extractedContext) // 将提取到的Context作为父级
                .startSpan();

        try (Scope scope = span.makeCurrent()) {
            System.out.println("Receiver Span ID: " + span.getSpanContext().getSpanId());
            System.out.println("Receiver Parent Span ID (from Context): " + Span.fromContext(extractedContext).getSpanContext().getSpanId());
            // 模拟执行一些业务逻辑
            // ...
        } finally {
            span.end(); // 结束Span
        }
    }

    public static void main(String[] args) {
        OpenTelemetry openTelemetry = OpenTelemetry.noop(); // 实际应用中会使用SDK初始化

        // 模拟从SenderService接收到的headers
        Map receivedHeaders = new HashMap<>();
        receivedHeaders.put("traceparent", "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"); // 示例W3C Trace Context头

        ReceiverService receiver = new ReceiverService(openTelemetry);
        receiver.processRemoteCall(receivedHeaders);
    }
}

在上述代码中：

  • openTelemetry.getPropagators().getTextMapPropagator().extract()从headers中读取跟踪信息，并将其解析成一个新的Context对象。TextMapGetter定义了如何从载体中获取键值对。
  • tracer.spanBuilder("processRequest").setParent(extractedContext).startSpan()创建了一个新的Span，并明确地将其父级设置为从远程请求中提取的extractedContext。这样，新的Span就会与远程的父Span关联起来，形成完整的跟踪链。

注意事项与最佳实践

  1. 统一传播协议：确保所有服务都使用相同的TextMapPropagator配置。OpenTelemetry默认推荐并支持W3C Trace Context标准，它能够跨语言和框架进行互操作。
  2. 避免直接传递Span对象：永远不要尝试序列化或反序列化Span对象，或者将其作为方法参数在不同进程间传递。Span对象是本地资源，其生命周期和状态管理由SDK负责。
  3. 理解Context的作用：Context是传递跟踪信息的正确方式。它是一个不可变且线程安全的容器，用于在代码执行流中传递隐式数据。
  4. 自动和手动埋点结合：对于常见的HTTP、gRPC、消息队列等，OpenTelemetry提供了大量的自动埋点（Auto-instrumentation），可以自动处理上下文传播。对于自定义协议或特定业务逻辑，才需要进行手动埋点。
  5. Span ID仅是标识符：再次强调，Span ID只是一个标识符，它不提供获取对应Span对象的API。跟踪系统的核心在于通过Context来构建和关联Span树。

总结

在OpenTelemetry Java中，直接通过Span ID获取Span对象是不可行的。要实现分布式系统中的父子Span关联，必须依赖于上下文传播（Context Propagation）机制。通过TextMapPropagator在发送方注入上下文到请求载体中，并在接收方从载体中提取上下文，然后使用提取到的Context作为新Span的父级，可以确保分布式跟踪链的正确连接。理解并正确应用这一机制是构建有效OpenTelemetry可观测性解决方案的关键。

ai app java 键值对

相关文章

按ESC键退出。