通过Jaeger客户端上报Java应用数据 - 可观测链路 OpenTelemetry 版

通过Jaeger为应用埋点并上报链路数据至可观测链路 OpenTelemetry 版后，可观测链路 OpenTelemetry 版即可开始监控应用，您可以查看应用拓扑、调用链路、异常事务、慢事务和SQL分析等一系列监控数据。本文介绍如何进行手动埋点，以及使用Spring Cloud组件和gRPC组件进行自动埋点。

重要

为获得更丰富的功能、更先进的链路追踪能力，以及最佳使用体验，建议您使用OpenTelemetry协议将应用接入可观测链路 OpenTelemetry 版。

我们为您提供了详细的OpenTelemetry接入指南和最佳实践，帮助您快速上手可观测链路 OpenTelemetry 版。更多信息，请参见接入应用。

前提条件

获取接入点信息

新版控制台

登录可观测链路 OpenTelemetry 版控制台，在左侧导航栏单击接入中心。
在开源框架区域单击Jaeger卡片。
在弹出的Jaeger面板中选择数据需要上报的地域。
说明
初次接入的地域将会自动进行资源初始化。
选择连接方式和上报方式，然后复制接入点信息。
- 连接方式：若您的服务部署在阿里云上，且所属地域与选择的接入地域一致，推荐使用阿里云内网方式，否则选择公网方式。
- 上报方式：根据客户端支持的协议类型选择HTTP或gRPC协议上报数据。

旧版控制台

登录可观测链路 OpenTelemetry 版控制台。
在左侧导航栏单击集群配置，然后在右侧页面单击接入点信息页签。
在页面顶部选择需要接入的地域，然后在集群信息区域打开显示Token开关。
在客户端采集工具区域单击Jaeger。
在相关信息列中，获取接入点信息。
说明
如果应用部署于阿里云生产环境，则选择阿里云VPC网络接入点，否则选择公网接入点。

背景信息

Jaeger是一款开源分布式追踪系统，兼容OpenTracing API，且已加入CNCF开源组织。其主要功能是聚合来自各个异构系统的实时监控数据。目前OpenTracing社区已有许多组件可支持各种Java框架，例如：

要通过Jaeger将Java应用数据上报至可观测链路 OpenTelemetry 版控制台，首先需要完成埋点工作。您可以手动埋点，也可以利用各种现有插件实现埋点的目的。本文介绍以下三种埋点方法。

手动埋点
通过Spring Cloud组件埋点
通过gRPC组件埋点

数据是如何上报的？

不通过Jaeger Agent而直接上报数据的原理如下图所示。
通过Jaeger Agent上报数据的原理如下图所示。

为Java应用手动埋点

要通过Jaeger将Java应用数据上报至可观测链路 OpenTelemetry 版控制台，首先需要完成埋点工作。本示例为手动埋点。

下载Demo工程，进入manualDemo目录，并按照Readme的说明运行程序。

打开pom.xml，添加对Jaeger客户端的依赖。

<dependency>
    <groupId>io.jaegertracing</groupId>
    <artifactId>jaeger-client</artifactId>
    <version>0.31.0</version>
</dependency>

配置初始化参数并创建Tracer对象。

Tracer对象可以用来创建Span对象以便记录分布式操作时间、通过Extract/Inject方法跨机器透传数据、或设置当前Span。Tracer对象还配置了上报数据的网关地址、本机IP地址、采样率、服务名等数据。您可以通过调整采样率来减少因上报数据产生的开销。

说明

请将<endpoint>替换成可观测链路 OpenTelemetry 版控制台集群配置 > 接入点信息页面相应客户端和地域的接入点。获取接入点信息的方法，请参见前提条件。

// 将manualDemo替换为您的应用名称。
io.jaegertracing.Configuration config = new io.jaegertracing.Configuration("manualDemo");
io.jaegertracing.Configuration.SenderConfiguration sender = new io.jaegertracing.Configuration.SenderConfiguration();
// 将 <endpoint> 替换为控制台概览页面上相应客户端和地域的接入点。
sender.withEndpoint("<endpoint>");
config.withSampler(new io.jaegertracing.Configuration.SamplerConfiguration().withType("const").withParam(1));
config.withReporter(new io.jaegertracing.Configuration.ReporterConfiguration().withSender(sender).withMaxQueueSize(10000));
GlobalTracer.register(config.getTracer());

记录请求数据。

Tracer tracer = GlobalTracer.get();
// 创建Span。
Span span = tracer.buildSpan("parentSpan").withTag("myTag", "spanFirst").start();
tracer.scopeManager().activate(span, false);
tracer.activeSpan().setTag("methodName", "testTracing");
// 业务逻辑。
secondBiz();
span.finish();

可选：上一步用于记录请求的根操作，如果需要记录请求的上一步和下一步操作，则需要传入上下文。

Tracer tracer = GlobalTracer.get();
Span parentspan = tracer.activeSpan();
Tracer.SpanBuilder spanBuilder = tracer.buildSpan("childSpan").withTag("myTag", "spanSecond");
if (parentspan !=null) {
    spanBuilder.asChildOf(parentspan).start();
}
Span childSpan = spanBuilder.start();
Scope scope = tracer.scopeManager().activate(childSpan); // 请求开始执行一次
// 业务逻辑。 可以执行多次 buildSpan
childSpan.finish();
tracer.activeSpan().setTag("methodName", "testCall");

// 请求结束执行一次
scope.close();

可选：为了方便排查问题，您可以为某个记录添加一些自定义标签（Tag），例如记录是否发生错误、请求的返回值等。
```
tracer.activeSpan().setTag("methodName", "testCall");
```

在分布式系统中发送RPC请求时会带上Tracing数据，包括TraceId、ParentSpanId、SpanId、Sampled等。您可以在HTTP请求中使用Extract/Inject方法在HTTP Request Headers上透传数据。总体流程如下：

在客户端调用Inject方法传入Context信息。

private void attachTraceInfo(Tracer tracer, Span span, final Request request) {
        tracer.inject(span.context(), Format.Builtin.TEXT_MAP, new TextMap() {
            @Override
            public void put(String key, String value) {
                request.setHeader(key, value);
            }
            @Override
            public Iterator<Map.Entry<String, String>> iterator() {
                throw new UnsupportedOperationException("TextMapInjectAdapter should only be used with Tracer.inject()");
            }
        });
    }

在服务端调用Extract方法解析Context信息。

protected Span extractTraceInfo(Request request, Tracer tracer) {
    Tracer.SpanBuilder spanBuilder = tracer.buildSpan("/api/xtrace/test03");
    try {
        SpanContext spanContext = tracer.extract(Format.Builtin.TEXT_MAP, new TextMapExtractAdapter(request.getAttachments()));
        if (spanContext !=null) {
            spanBuilder.asChildOf(spanContext);
        }
    } catch (Exception e) {
        spanBuilder.withTag("Error", "extract from request fail, error msg:" + e.getMessage());
    }
    return spanBuilder.start();
}

通过Spring Cloud组件为Java应用埋点

要通过Jaeger将Java应用数据上报至可观测链路 OpenTelemetry 版控制台，首先需要完成埋点工作。本示例为通过Spring Cloud组件埋点。Spring Cloud提供了下列组件的埋点：

@Async, @Scheduled, Executors
Feign, HystrixFeign
Hystrix
JDBC
JMS
Mongo
RabbitMQ
Redis
RxJava
Spring Messaging - 链路消息通过消息通道发送
Spring Web (RestControllers, RestTemplates, WebAsyncTask)
Standard Logging - 日志被添加至当前Span
WebSocket STOMP
Zuul

请按照以下步骤通过Spring Cloud组件埋点。

说明

请下载Demo工程，进入springMvcDemo/webmvc4-boot目录，并按照Readme的说明运行程序。

打开pom.xml，添加Jar包依赖。

<dependency>
   <groupId>io.opentracing.contrib</groupId>
  <artifactId>opentracing-spring-cloud-starter</artifactId>
  <version>0.5.8</version>
</dependency>
<dependency>
  <groupId>io.jaegertracing</groupId>
  <artifactId>jaeger-client</artifactId>
  <version>1.4.0</version>
</dependency>

添加OpenTracing Tracer Bean。

说明

@Bean
public io.opentracing.Tracer tracer() {
    io.jaegertracing.Configuration config = new io.jaegertracing.Configuration("springFrontend");
    io.jaegertracing.Configuration.SenderConfiguration sender = new io.jaegertracing.Configuration.SenderConfiguration();
    sender.withEndpoint("<endpoint>");
    config.withSampler(new io.jaegertracing.Configuration.SamplerConfiguration().withType("const").withParam(1));
    config.withReporter(new io.jaegertracing.Configuration.ReporterConfiguration().withSender(sender).withMaxQueueSize(10000));
    return config.getTracer();
}

通过gRPC组件为Java应用埋点

要通过Jaeger将Java应用数据上报至可观测链路 OpenTelemetry 版控制台，首先需要完成埋点工作。本示例为通过gRPC组件埋点。

请按照以下步骤通过gRPC组件埋点。

说明

请下载Demo工程，进入grpcDemo目录，并按照Readme的说明运行程序。

打开pom.xml，添加Jar包依赖。

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-grpc</artifactId>
    <version>0.2.3</version>
</dependency>

在服务端初始化Tracing对象，创建ServerTracingInterceptor，并添加对Server的拦截。

import io.opentracing.Tracer;

    public class YourServer {

        private int port;
        private Server server;
        private final Tracer tracer;

        private void start() throws IOException {
            ServerTracingInterceptor tracingInterceptor = new ServerTracingInterceptor(this.tracer);

            // If GlobalTracer is used: 
            // ServerTracingInterceptor tracingInterceptor = new ServerTracingInterceptor();

            server = ServerBuilder.forPort(port)
                .addService(tracingInterceptor.intercept(someServiceDef))
                .build()
                .start();
        }
    }

在客户端初始化Tracing对象，创建ClientTracingInterceptor，并添加对Client Channel的拦截。

import io.opentracing.Tracer;

    public class YourClient {

        private final ManagedChannel channel;
        private final GreeterGrpc.GreeterBlockingStub blockingStub;
        private final Tracer tracer;

        public YourClient(String host, int port) {

            channel = ManagedChannelBuilder.forAddress(host, port)
                .usePlaintext(true)
                .build();

            ClientTracingInterceptor tracingInterceptor = new ClientTracingInterceptor(this.tracer);

            // If GlobalTracer is used: 
            // ClientTracingInterceptor tracingInterceptor = new ClientTracingInterceptor();

            blockingStub = GreeterGrpc.newBlockingStub(tracingInterceptor.intercept(channel));
        }
    }

常见问题

问：Demo程序执行成功，为什么控制台上没有上报数据？

答：请调试方法io.jaegertracing.thrift.internal.senders.HttpSender.send(Process process, List<Span> spans)，并查看上报数据时的返回值。如果报403错误，则表明接入点配置不正确，请检查并修改。