服务链路追踪Spring Cloud Sleuth

微服务系统往往有很多个服务单元，由于服务单元数量众多，业务的复杂性较高，如果出现了错误和异常，很难定位。主要体现在一个请求可能需要调用很多个服务，而内部服务之间的调用决定了问题难以定位。所以微服务架构中，需要实现分布式链路追踪，去跟进一个请求到底有那些服务参与，参与的顺序又是怎样的，从而达到每个请求的步骤清晰可见，出现了问题能够快速定位。本章主要讲诉如何在Spring Cloud Sleuth集成Zipkin(一个链路追踪组件)，来实现链路追踪的功能。
本章依然使用前面讲解其他组件所建的工程，github地址。

基本术语

• Span
  基本的工作单元，发送一个远程调度任务就会产生一个Span。Span是用一个64为ID唯一标识。
• Trace
  由一系列Span组成的，呈树状结构。请求一个微服务系统的API接口，这个API接口需要调用多个微服务单元，调用每一个微服务单元都会产生一个新的Span，所有由这个请求产生的Span组成了这个Trace。
• Annotation
  记录一个事件，一些核心注解用于定义一个请求的开始和结束。

构建Zipkin Server

和之前的工程一样，新建一个Module工程，取名为zipken-server。

• 第一步添加pom依赖，引入eureka起步依赖、Zipkin Server的依赖以及Zipkin Server的UI界面依赖。

       <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
      </dependency>

        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>

• 在程序启动类添加@EnableZipkinServer开启ZipkinServer的功能，加上@EnableEurekaClient启动Eureka Client。

@SpringBootApplication
@EnableEurekaClient
@EnableZipkinServer
public class ZipkanServerApplication {

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

}

• 配置文件中做相关配置，指定端口号和配置服务注册中心等。

server:
  port: 9411
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
spring:
  application:
    name: zipken-server

配置Zipkin Client

根据以上的步骤我们已经成功配置了一个简单的Zipkin Server，server的地址为本地的9411端口。在之前介绍Zuul网关时我们实现了访问网关转发到eureka-client服务的功能，接下来我们来实现这一链路的记录，再此之前需要改造api-gateway
服务和eureka-client服务。

• 在api-gateway和eureka-client服务中添加zipkin的依赖

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
            <version>RELEASE</version>
</dependency>

• 在api-gateway和eureka-client服务的配置文件中添加Zipkin Server的配置。

spring:
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      percentage: 1.0

其中spring.sleuth.sampler.percentage为1.0，表示以100%的概率将链路的数据上传给Zipkin Server，在默认的情况下，该值为0.1。

• 测试
  启动eureka-server、zipkin-server、api-gateway、eureka-client四个服务。通过api-gateway访问一次eureka-client的接口。访问本地的9411端口，即访问zipkin的展示界面。界面及介绍如下。

  
  image.png
  image.png

在链路数据中添加自定义数据

现在需要一个这样的需求：在链路数据中加上请求的操作人。如何实现呢？在介绍Zuul时介绍过ZuulFilter过滤器。在这个需求中我们可以通过此过滤器获取操作人，通过Tracer的addTag方法加上自定义的数据。

@Component
public class ZipkinFilter extends ZuulFilter {
    @Autowired
    private Tracer tracer;

    @Override
    public String filterType() {
        return FilterConstants.POST_TYPE;
    }

    @Override
    public int filterOrder() {
        return 900;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        tracer.addTag("operator","dzy");
        return null;
    }
}

点击Zipkin UI中的JSON按钮，可查询链路的json信息，其中可以查询添加的自定义信息。

image.png

在MySql数据库中存储链路数据

在上面的例子中，Zipkin Server将数据存储在内存中，一旦程序重启，之前的链路数据全部丢失。此外项目中会运用自己的前端框架来展示服务的链路信息，而不会使用Zipkin Server自带的UI界面，此时就需要把链路信息单独存储起来，通过接口的形式返回给前端展示。现在讲解使用MySql存储链路数据。

• 只需要改造zipkin-server工程，在此工程中添加Zipkin的MySQL存储依赖zipkin-storage-mysql,MySQL的连接器依赖和JDBC的起步依赖。

        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-storage-mysql</artifactId>
            <version>1.19.0</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>

• 在配置文件中配置MySQL的信息，并需要配置zipkin.storage.type为mysql。

spring:
  application:
    name: zipken-server
  datasource:
    url: 数据库地址
    username: 数据库用户名
    password: 数据库密码
    driver-class-name: com.mysql.jdbc.Driver
zipkin:
  storage:
    type: mysql

• 在mysql数据库中初始化数据库脚本，脚本地址脚本地址
  

  image.png

• 注入MySQLStorege的Bean

@Configuration
public class ZipkinConfig {
    @Bean
    public MySQLStorage mySQLStorage(DataSource dataSource) {
        return MySQLStorage.builder().datasource(dataSource).executor(Runnable::run).build();
    }
}

再次访问接口即可把链路信息存储在MySQL数据库中。

总结

在这一章中学习了为什么需要服务链路追踪，以及如何搭建一个简单的ZipKin Server,以及在各个链路中的服务中的配置。接着介绍了如何在链路中添加自定义数据，最后使用了MySQL数据库来存储链路的信息来做持久化操作。在下一章一起学习微服务的监控。