【Spring Cloud Sleuth】分布式跟踪服务-快速入

分布式服务随着业务的发展，系统规模也会变得越来越大，各服务之间的调用关系也变得越来约复杂。通常一个由客户端发起的请求在后端系统中会经过多个不同的微服务调用来协同产生最后的请求结果，在复杂的微服务架构系统中，几乎每一个前端请求都有可能引起请求最后的失败。这时候，对于每一个依赖服务出现延迟过高或者错误的时候都有可能引起服务最后的失败。这时候，对于每个请求，全链路调用的跟踪就变得越来越重要，通过实现对请求调用的根据可以帮助我们快速发现错误根源以及监控分析每条请求链路上的性能瓶颈。针对上面问题，Spring Cloud Sleuth提供了一套完整的解决方案

快速入门
在引入Sleuth之前，我们依赖本人其他博客内容，构建一些基础设施和引用
.服务注册中心Eureka
.微服务应用:trace-1,实现一个Rest接口/trace-1，调用接口后将触发对trace2应用的调用，具体实现如下：
pom依赖：

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

.应用trace1、trace2的application.yml配置：

# 只列出了trace1应用的配置文件，trace2应用配置内容类似
server:
  port: 8201
spring:
  application:
    name: trace1
eureka:
  instance:
    instance-id: trace:8201
    hostname: trace1
  client:
    fetch-registry: true
    register-with-eureka: true
    serviceUrl:
      defaultZone: http://localhost:8761/eureka,http://localhost:8762/eureka

.trace1、trace2应用启动类
将trace1、trace2应用注册到Eureka注册中心

@SpringBootApplication
@EnableEurekaClient
public class Tracing1Application {
    @Bean
    @LoadBalanced
    RestTemplate restTemplate() {
        return new RestTemplate();
    }

    public static void main(String[] args) {
        SpringApplication.run(Tracing1Application.class, args);
    }
}

.trace1应用REST接口

@RestController
@Slf4j
public class Trace {
    @Autowired
    RestTemplate restTemplate;
    @GetMapping("/trace-1")
    public String trace() {
        log.info("=====call trace-1====");
        return restTemplate.getForEntity("http://trace2/trace-2",String.class).getBody();
    }
}

.trace2应用REST接口

@RestController
@Slf4j
public class Trace {
    @Autowired
    RestTemplate restTemplate;
    @GetMapping("/trace-2")
    public String trace() {
        log.info("=====call trace-2====");
        return "Trace";
    }
}

.浏览器调用http://localhost:8201/trace-1，显示结果如下：

# trace1
2018-10-28 12:57:05.738  INFO [trace1,fc2ec50d569fb572,fc2ec50d569fb572,false] 2423 --- [nio-8201-exec-6] s.tracing1.traceController.Trace         : =====call trace-1====
# trace2 
2018-10-28 12:57:11.227  INFO [trace2,fc2ec50d569fb572,0e335c29b8314c9d,false] 2431 --- [nio-8202-exec-3] s.tracing2.traceController.Trace         : =====call trace-2====

从控制台输出的内容中，我们可以看到打印出了[trace1,fc2ec50d569fb572,fc2ec50d569fb572,false]信息，这些元素正式分布式跟踪的重要组成部分，各元素含义如下：
.第一个值：trace1，应用的名称，application.yml文件中对应的spring.application.name
.第二个值：fc2ec50d569fb572，Spring Cloud Sleuth生成的Trace ID,用于表示一条请求链路。一个请求链路可以包含一个Trace ID和多个Span ID
.第三个值：0e335c29b8314c9d，Span ID，它表示一个基本的工作单。
.第四个值：false，表示是否将该信息输出到Zipkin等服务中来收集和展示

.跟踪原理
也可以通过在trace2的/trace-2方法中增加下面的输出，打印出traceId和spanId

@RestController
@Slf4j
public class Trace {
    @Autowired
    RestTemplate restTemplate;
    @GetMapping("/trace-2")
    public String trace(HttpServletRequest request) {
        log.info("=====call trace-2====，Trace ID={},Span ID={}",
                request.getHeader("X-B3-TraceId"),
                request.getHeader("X-B3-SpanId"));
        return "Trace";
    }
}

# trace1应用输出
2018-10-28 13:37:38.477  INFO [trace1,8556870ade8f4c38,8556870ade8f4c38,false] 2423 --- [io-8201-exec-10] s.tracing1.traceController.Trace         : =====call trace-1====
# trace2应用输出
2018-10-28 13:37:38.584  INFO [trace2,8556870ade8f4c38,7ee6e8ed174f3b18,false] 2815 --- [nio-8202-exec-1] s.tracing2.traceController.Trace         : =====call trace-2====，Trace ID=8556870ade8f4c38,Span ID=7ee6e8ed174f3b18

.X-B3-TraceId：一条链路（Trace）的唯一标识
.X-B3-SpanId：一个工作单元（Span）的唯一标识
.X-B3-ParentSpanId：标示当前工作单元所属的上一个工作单元，Root Span（请求链路的第一个工作单元）的该值为空。
.X-B3-Sampled：是否被抽样输出的标志，1标示需要输出，0标示不需要
.X-Span-Name：工作单元名称