springcloud-Sleuth(zipkin)详解(含java代码)

什么是springcloud-sleuth

• Spring Cloud Sleuth 是分布式系统中跟踪服务间调用的工具，它可以直观地展示出一次请求的调用过程
  • 随着我们的系统越来越庞大，各个服务间的调用关系也变得越来越复杂。
  • 当客户端发起一个请求时，这个请求经过多个服务后，最终返回了结果，经过的每一个服务都有可能发生延迟或错误，从而导致请求失败。
  • 这时候我们就需要请求链路跟踪工具来帮助我们，理清请求调用的服务链路，解决问题。
• Spring Cloud Sleuth是对Zipkin的一个封装
  • Zipkin分布式跟踪系统
    • 它可以帮助收集时间数据，解决在microservice架构下的延迟问题
    • 它管理这些数据的收集和查找
    • 每个应用程序向Zipkin报告定时数据
    • Zipkin UI呈现了一个依赖图表来展示多少跟踪请求经过了每个应用程序
    • 如果想解决延迟问题，可以过滤或者排序所有的跟踪请求，并且可以查看每个跟踪请求占总跟踪时间的百分比。
    • 其基本思路是在服务调用的请求和响应中加入ID，标明上下游请求的关系。利用这些信息，可以可视化地分析服务调用链路和服务间的依赖关系。
• sleuth目前支持的有
  • spring的Scheduled、RestTemplate、feign、quartz、zuul、hystrix、kafka、redis、rxjava、grpc、Opentracing、Reator、circuitbreaker
  • 国内用的比较多的dubbo，sleuth无法对其提供支持。

zipkin基本参数概念

• span

  • span是sleuth中最基本的工作单元
  • 一个微服务收到请求后会创建一个span同时产生一个span id
  • span id是一个64位的随机数，sleuth将其转化为16进制的字符串，打印在日志里面。
  • 其对应的实现类是RealSpan。

• trace id：在一个调用链条中，trace id是始终不变的

  • 每经过一个微服务 span id生成一个新的，所以通过trace id可以找出调用链上所有经过的微服务。
  • trace id默认是64位，可以通过spring.sleuth.traceId128=true设置trace id为128位。
  • 调用链的第一个服务，其span id和trace id是同一个值。

• zipkin原理

  • 跟踪器(Tracer)位于你的应用程序中
  • 记录发生的操作的时间和元数据,提供了相应的类库
  • 对用户的使用来说是透明的，收集的跟踪数据称为Span
  • 将数据发送到Zipkin的仪器化应用程序中的组件称为Reporter
  • Reporter通过几种传输方式之一将追踪数据发送到Zipkin收集器(collector)
  • 然后将跟踪数据进行存储(storage),由API查询存储以向UI提供数据。

• 持久化

  • 支持mysql和es(推荐)

mysql持久化zipkin配置(只做了解)

• 依赖

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

• 配置

#zipkin数据保存到数据库中需要进行如下配置
#表示当前程序不使用sleuth
spring.sleuth.enabled=false
#表示zipkin数据存储方式是mysql
zipkin.storage.type=mysql
 
#数据库脚本创建地址，当有多个时可使用[x]表示集合第几个元素，脚本可到官网下载，需要先手动到数据库执行
spring.datasource.schema[0]=classpath:/zipkin.sql
 
#spring boot数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/zipkin?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.initialize=true
spring.datasource.continue-on-error=true

Java实现zipkin

请先参照前文创建好服务

• 给服务添加请求链路跟踪
  • 我们将通过user-service和ribbon-service之间的服务调用来演示该功能
  • 这里我们调用ribbon-service的接口时，ribbon-service会通过RestTemplate来调用user-service提供的接口。
• 首先给user-service和ribbon-service添加请求链路跟踪功能的支持；
  • 在user-service和ribbon-service中添加相关依赖：

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

• 修改application.yml文件，配置收集日志的zipkin-server访问地址：

spring:
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      probability: 0.1 #设置Sleuth的抽样收集概率

整合Zipkin获取及分析日志

• Zipkin是Twitter的一个开源项目，可以用来获取和分析Spring Cloud Sleuth 中产生的请求链路跟踪日志
• 它提供了Web界面来帮助我们直观地查看请求链路跟踪信息。
• SpringBoot 2.0以上版本已经不需要自行搭建zipkin-server，我们可以从该地址下载zipkin-server：https://repo1.maven.org/maven2/io/zipkin/java/zipkin-server/2.12.9/zipkin-server-2.12.9-exec.jar
• 下载完成后使用以下命令运行zipkin-server
  • java -jar zipkin-server-2.12.9-exec.jar
• Zipkin页面访问地址：http://localhost:9411
  
• 启动eureka-sever，ribbon-service，user-service：
  
• 多次调用（Sleuth为抽样收集）ribbon-service的接口http://localhost:8301/user/1 ，调用完后查看Zipkin首页发现已经有请求链路跟踪信息了；
  
• 点击查看详情可以直观地看到请求调用链路和通过每个服务的耗时：
  

使用Elasticsearch存储跟踪信息

• 如果我们把zipkin-server重启一下就会发现刚刚的存储的跟踪信息全部丢失了，可见其是存储在内存中的
• 有时候我们需要将所有信息存储下来，这里以存储到Elasticsearch为例，来演示下该功能。

安装Elasticsearch

• 下载Elasticsearch6.2.2的zip包，并解压到指定目录，下载地址：
  https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2

• 运行bin目录下的elasticsearch.bat启动Elasticsearch
  
• 修改启动参数将信息存储到Elasticsearch
  • 使用以下命令运行，就可以把跟踪信息存储到Elasticsearch里面去了，重新启动也不会丢失；

# STORAGE_TYPE：表示存储类型 ES_HOSTS：表示ES的访问地址
java -jar zipkin-server-2.12.9-exec.jar --STORAGE_TYPE=elasticsearch --ES_HOSTS=localhost:9200 

• 之后需要重新启动user-service和ribbon-service才能生效，重启后多次调用ribbon-service的接口http://localhost:8301/user/1
• 如果安装了Elasticsearch的可视化工具Kibana的话，可以看到里面已经存储了跟踪信息：
  

更多启动参数可参考

• https://github.com/openzipkin/zipkin/tree/master/zipkin-server#elasticsearch-storage