Sleuth 通过 traceId 实现了对分布式系统调用链路的跟踪。在一次服务请求链路中，会保持并传递一个 traceId，从而将不同服务的请求跟踪信息串联起来，不同服务的 traceId 相同表示处在同一请求链中。

基于 HTTP 请求的数据传递有两种方式：一种是做为参数传递，另一种是做为头信息传递。而 Sleuth 的 traceId 属于附加信息，不参与实际的业务，所以做为参数传递并不合适，实际也是作为头信息来传递的。

1. Sleuth跟踪原理

分布式系统中的服务调用链路跟踪在理论上并不复杂，主要有个关键点，一个是为请求链路创建唯一跟踪标识，二个统计各个处理单元的延迟时间。

1. 为了实现请求链路跟踪，当请求发送到分布式系统的入口时，只需要在服务跟踪框架为该请求创建唯一的跟踪标识，并保证该标识在在分布式系统内部流转，直到返回请求为止。该标识即为 traceId，通过该标识，就能将不同服务调用的日志串联起来。
2. 为了统计各处理单元(应用服务)的延迟，当请求到达或处理逻辑达到某个状态时，也通过一个唯一标识来标记开始、具体过程及结束(标识一个服务内请求进入、处理到结束)，该标识即为 spanId。对于每个 spanId 来说，必须有开始和结束两个节点，通过计算开始 span 和 结束 span 的时间戳，就能统记出该 span 的时间延迟。

参考 Spring Cloud系列(十三)：分布式服务链路跟踪 Sleuth 中的示例项目，Sleuth 会在请求的 Header 中增加实现跟踪需的信息，给远程调用接口打上断点，使用 request.getHeaderNames() 取出所有头信息。

["x-b3-spanid","x-b3-parentspanid","x-b3-sampled","x-b3-traceid","accept","user-agent","host","connection"]

可以看到，在请求头信息中多了 4 个属性：

• x-b3-spanid：一个工作单元(rpc 调用)的唯一标识。
• x-b3-parentspanid：当前工作单元的上一个工作单元，Root Span(请求链路的第一个工作单元)的值为空。
• x-b3-traceid：一条请求链条(trace) 的唯一标识。
• x-b3-sampled：是否被抽样为输出的标志，1 为需要被输出，0 为不需要被输出。

2. 日志跟踪接入

Sleuth 会把跟踪数据 (appname、traceId、spanId、exportable) 添加到 Slf4J MDC 中，因此您可以从日志聚合器中的给定跟踪或跨度中提取所有日志，如以下示例日志中所示：

2016-02-02 15:30:57.902  INFO [bar,6bfd228dc00d216b,6bfd228dc00d216b,false] 23030 --- [nio-8081-exec-3] ...
2016-02-02 15:30:58.372 ERROR [bar,6bfd228dc00d216b,6bfd228dc00d216b,false] 23030 --- [nio-8081-exec-3] ...
2016-02-02 15:31:01.936  INFO [bar,46ab0d418373cbc9,46ab0d418373cbc9,false] 23030 --- [nio-8081-exec-4] ...

MDC 的实现实际是将需要记录到日志的信息设置到当前线程的上下文(ThreadContext)中。

MDC 中的信息：[appname,traceId,spanId,exportable]

• appname：应用名称，即 spring.application.name 的值。
• tranceId：整个请求链路的唯一ID。
• spanId：基本的工作单元，一个 RPC 调用就是一个新的 span。启动跟踪的初始 span 称为 root span ，此 spanId 的值与 traceId 的值相同。
• exportable：是否将数据导入到 Zipkin 中，true 表示导入成功，false 表示导入失败。

3. Sleuth采样比例

跟踪信息收集默认是 0.1(10%) 的采样比例，可通过 probability 属性修改；或可采用每秒速率来控制采集数据，属性是 rate。

# 跟踪信息收集采样比例，默认 0.1，为 1 是即 100%，收集所有
spring.sleuth.sampler.probability=1
# 每秒速率，即每秒最多能跟踪的请求，rate 优先
spring.sleuth.sampler.rate=50

4. 源码分析

源码分析基于Spring Cloud Hoxton，Spring Cloud Sleuth版本为2.2.0.RELEASE

SpringBoot 2开始使用了brave框架完成日志收集，brave是zipkin官方提供的java版本客户端，它将收集的跟踪信息，以Span的形式上报给Zipkin系统。

下面假设有client，server两个工程，调用链路如下：

用户 -> client --> server

我们来探讨以下几个问题

1. 用户调用client时，client如何生成Span信息

2. client调用server时，如何将Span发送到server

3. server如何接收cliend的Span信息

4. client，server如何发送Span到zipkin

注意，本文是基于SpringMvc+RestTeamplate的请求调用的，而非WebFlux异步调用。

4.1 用户调用client时，client如何生成Span信息

4.1.1 LazyTracingFilter

问题1和问题3，都由LazyTracingFilter处理，它在TraceWebServletAutoConfiguration中初始化。（本文部分源码来自于brave框架）LazyTracingFilter#doFilter -> (brave)TracingFilter#doFilter

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
...

    // #1
    Span span = handler.handleReceive(new HttpServerRequest(httpRequest));

    // #2
    request.setAttribute(SpanCustomizer.class.getName(), span.customizer());
    request.setAttribute(TraceContext.class.getName(), span.context());

    Throwable error = null;

    // #3
    Scope scope = currentTraceContext.newScope(span.context());
    try {
      chain.doFilter(httpRequest, httpResponse);
    } ...
    finally {
      // #4
      scope.close();
      if (servlet.isAsync(httpRequest)) { // we don't have the actual response, handle later
        servlet.handleAsync(handler, httpRequest, httpResponse, span);
      } else { // we have a synchronous response, so we can finish the span
        handler.handleSend(servlet.httpServerResponse(httpRequest, httpResponse), error, span);
      }
    }
}

1. 从Http Request的Header里获取Span数据，如果Header中存在X-B3-TraceId,X-B3-SpanId,X-B3-ParentSpanId属性，就说明调用链前一个节点已经生成Span，并传递下来，这时可以直接使用这些Span数据。否则，创建一个新的Span。
2. 记录一些Span的属性
3. 调用ThreadLocalCurrentTraceContext#newScope，保存当前的Span信息，当应用向下传递Span信息时需要使用这些信息。这里会调用ThreadLocalCurrentTraceContext#decorateScope，它会获取上下文的ScopeDecorator，并触发其decorateScope方法。SleuthLogAutoConfiguration构建了默认的ScopeDecorator -- Slf4jScopeDecorator，它会获取Span中的traceId，parentId，spanId，放置MDC中，方便日志打印。TraceAutoConfiguration负责构建ThreadLocalCurrentTraceContext，并将Slf4jScopeDecorator添加到ThreadLocalCurrentTraceContext#decorateScope中
4. 关闭Scope，记录server finishTimestamp(ss)。

4.1.2 HttpServerHandler#handleReceive

public Span handleReceive(HttpServerRequest request) {
    // #1
    Span span = nextSpan(defaultExtractor.extract(request), request);
    // #2
    return handleStart(new HttpServerRequest.ToHttpAdapter(request), request.unwrap(), span);
}

1. 调用B3Extractor#extract，会从Http Header中提取X-B3-TraceId,X-B3-SpanId,X-B3-ParentSpanId属性。
   nextSpan方法根据提取的结果，调用tracer.joinSpan或tracer.nextSpan方法。
2. 记录http.method，http.path，mvc.controller.class等Annotation，并记录server startTimestamp(sr)。

4.2 client调用server时，如何将Span发送到server

4.2.1 LazyTracingClientHttpRequestInterceptor

LazyTracingClientHttpRequestInterceptor负责实现该功能。它在TraceWebClientAutoConfiguration中构建。LazyTracingClientHttpRequestInterceptor#interceptor -> TracingClientHttpRequestInterceptor#intercept(brave)

public ClientHttpResponse intercept(HttpRequest request, byte[] body,
    ClientHttpRequestExecution execution) throws IOException {
    // #1
    Span span = handler.handleSend(new HttpClientRequest(request));
    HttpClientResponse response = null;
    Throwable error = null;
    // #2
    try (Tracer.SpanInScope ws = tracer.withSpanInScope(span)) {
      // #3
      ClientHttpResponse result = execution.execute(request, body);
      response = new HttpClientResponse(result);
      return result;
    } catch (IOException | RuntimeException | Error e) {
      error = e;
      throw e;
    } finally {
      // #4
      handler.handleReceive(response, error, span);
    }
}

1. 将Span信息注入Http请求中
2. 将Span包装成Tracer.SpanInScope
3. 发送请求
4. 记录client finishTimestamp(cr)，并且上报span

4.2.2 HttpClientHandler#handleSend

public Span handleSend(HttpClientRequest request, Span span) {
    ...
    // #1
    defaultInjector.inject(span.context(), request);
    // #2
    return handleStart(new HttpClientRequest.ToHttpAdapter(request), request.unwrap(), span);
}

1. span是通过Tracer#nextSpan获取，该方法从ThreadLocalCurrentTraceContext#get获取当前的Span信息。再调用B3Propagation#inject方法将traceId，parentId，spanId注入Http Header中。
2. 记录Span相关信息，如client startTimestamp(cs)。

4.3 client，server如何发送Span到zipkin

那么Spring如何将span发送到zipkin？先看一个brave框架上报Span的简单例子

Sender sender = URLConnectionSender.create("http://localhost:9411/api/v1/spans")
AsyncReporter asyncReporter = AsyncReporter.builder(sender)
        .build(SpanBytesEncoder.JSON_V2);

Tracing tracing = Tracing.newBuilder()
        .spanReporter(asyncReporter)
        .build();

Tracer tracer = tracing.tracer();
Span span = tracer.newTrace().name("encode").start();
...
span.finish();

我们并不要自己上报数据，span.finish()方法中，brave会帮我们完成上报Span工作。

看一下上例中brave的组件类

• Tracing：负责提供其他组件类，如Tracer，Sampler。在TraceAutoConfiguration中构建。
• Tracer：管理一个请求链路，可以创建Span。
• Sender：负责将编码后的二进制数据发送给Zipkin。在ZipkinRestTemplateSenderConfiguration中构建一个RestTemplateSender，使用RestTemplate上报Span数据。
• AsyncReporter：异步上报器，调度Sender完成Span上报工作。在ZipkinAutoConfiguration中构建。

在Spring Cloud Sleuth中，

• TracingClientHttpRequestInterceptor#intercept方法'#4'步骤 -> RealSpan#finish -> ZipkinFinishedSpanHandler#handle。
• ZipkinFinishedSpanHandler#handle会调用Reporter#report来上报Span数据
• ZipkinFinishedSpanHandler是Tracing默认的FinishedSpanHandler。