Spring Cloud Sleuth服务链路追踪

一、简介

微服务结构是一个分布式架构，微服务系统按照业务划分服务单元，一个微服务系统往往有很多个服务单元。由于服务单元数量众多，服务单元之间的调用很复杂，一旦出现错误和异常，很难去定位。所以在微服务架构中必须实现分布式服务链路追踪。目前，常见的链路追踪组件有Google的Dapper，Twitter的Zipkin，以及阿里的Eagleeye（鹰眼）等，它们都是非常优秀的链路追踪开源组件。

本章主要讲述如何在Spring Cloud Sleuth中集成Zipkin。

二、基本术语

• Span：基本哦工作单元，发送一个远程调度任务就会产生一个Span，Span是用一个64位ID唯一标识的，Trace是用另一个64位ID唯一标识的。Span还包含了其它信息，例如：摘要，时间戳事件，Span的ID以及进程ID;
• Trace：由一系列的Span组成，呈树状结构。请求一个微服务系统的API接口，这个API接口需要调用多个微服务单元，调用每个微服务单元都会产生一个新的Span，所有由这个请求产生的Span组成这个Trace;
• Annotation：用于记录一个事件，一些核心注解用于定义一个请求的开始和结束，这些注解如下：
  • cs - Client Sent：客户端发送一个请求，表示Span的开始
  • sr - Server Received：服务端接收请求并准备开始处理它。(sr-cs)等于网络的延迟
  • ss - Server Sent：服务端发送响应，该注解表明请求处理的完成。(ss-sr)表示服务端处理请求的时间
  • cr - Client Received：客户端接收响应，此时Span结束。(cr-cs)表示整个请求所消耗的时间

如果一个服务的调用关系如下：

调用关系

那么此时将Span和Trace在一个系统中使用Zipkin注解的过程图形化：

Zipkin注解的过程图形化
每个颜色的表明一个Span(总计7个Spans，从A到G)，每个Span有类似的信息:

Trace Id = X
Span Id = D
Client Sent

此Span表示Span的Trance Id是X，Span Id是D，同时它发送一个Client Sent事件。

Spans 的parent/child关系图形化如下：

Spans的parent/child关系图形化

三、Spring Cloud Sleuth + Zipkin整合案例

3.1 相关工程说明

服务	端口	服务说明
eureka	8761	服务注册于发现
provider	8800	服务提供者
consumer	8801	服务消费者
chainMonitor	8770	链路追踪服务端

3.2 服务链路追踪服务端

1. pom.xml添加依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- zipkin 界面-->
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
            <version>2.11.5</version>
        </dependency>
        <!-- zipkin 服务类-->
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
            <version>2.11.5</version>
        </dependency>

2.配置文件

server:
  port: 8770

spring:
  application:
    name: chainmonitor

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
management:
  metrics:
    web:
      server:
        auto-time-requests: false

3.启动类添加注解@EnableZipkinServer

@SpringBootApplication
@EnableEurekaClient
@EnableZipkinServer
public class ChainmonitorApplication {

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

3.3 服务链路追踪客户端

3.3.1 服务提供者provider

1.pom.xml添加依赖

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

2.配置文件

server:
  port: 8800

spring:
  application:
    name: provider
  # zipkin的地址：通过真实IP地址访问  
  zipkin:
    base-url: http://localhost:8770
    #通过服务名访问
    #base-url: http://chainmonitor/
  sleuth:
    sampler:
      #设置采样率，为了测试设置100%采集，设置为1.0
      probability: 1.0
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

3.服务接口

@RestController
public class HelloController {
    @RequestMapping(value = "/getBookByName")
    public String getNameById(@RequestParam("id") String id){
        String bookName = "";
        switch (id){
            case "1" :
                bookName = "Java";
                break;
            case "2" :
                bookName = "C++";
                break;
            default:
                bookName = "phython";
        }
        return bookName;
    }
}

3.3.2 服务消费者consumer

1.pom.xml添加依赖

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

2.配置文件

server:
  port: 8801

spring:
  application:
    name: consumer
  # zipkin的地址：通过真实IP地址访问  
  zipkin:
    base-url: http://localhost:8770
    #通过服务名访问
    #base-url: http://chainmonitor/
  sleuth:
    sampler:
      #设置采样率，为了测试设置100%采集，设置为1.0
      probability: 1.0
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

3.feign远程调用接口

@FeignClient(name = "provider")
public interface FeignService {
    @RequestMapping(value = "/getBookByName",method = RequestMethod.GET)
    String getBookByName(@RequestParam("id") String id);
}

4.服务接口

@RestController
public class HelloController {
    @Autowired
    private FeignService feignService;

    @RequestMapping(value = "getBookName")
    public String getBookName(@RequestParam("id") String id){
        return feignService.getBookByName(id);
    }
}

四、zipkin中图形化数据解析

4.1 zipkin可视化成功调用

在Zipkin中展示了跟踪信息，红框里是一个Trace

Trace

点击每个Trace，可以看到多个Span

span
点击每个span,可以看到详细信息
span详细信息

4.2 zipkin可视化失败调用

如果调用链路中发生接口调用失败，zipkin会默认使用红色展示信息，如下图：

span

点击红色的span，可以看到详细的失败信息：

失败信息