Spring Cloud-Sleuth服务链路跟踪

简介

随着我们系统的庞大，各个服务间调用关系变得越来越复杂。当客户端发起一个请求时，这个请求经过多个服务后，最终返回了结果，中间经过的每个服务都有可能发生延迟或错误，从而导致请求失败。这个时候就需要请求链路跟踪工具来帮助我们，理清请求调用的服务链路，快速确定出问题点。

Spring Cloud Sleuth是分布式系统中跟踪服务间调用的工具，它可以直观地展示出一次请求的调用过程。

本文主要对其用法进行详细介绍。

给服务添加请求链路跟踪

我们将通过user-service和ribbon-service之间的服务调用来演示该功能，这里我们调用ribbon-service的接口时，ribbon-service会通过RestTemplate来调用user-service提供的接口。

首先给user-service和ribbon-service添加请求链路跟踪功能的支持。

在user-service和ribbon-service的pom.xml添加相关依赖：

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

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

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

整合Zipkin获取及分析日志

Zipkin是Twitter的一个开源项目，可以用来获取和分析Spring Cloud Sleuth中产生的请求链路跟踪日志，它提供了Web界面来帮助我们直观地查看请求链路跟踪信息。

SpringBoot2.0以上版本已经不需要自行搭建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

springcloud-sleuth-zipkin-01.png

启动eureka-server、ribbon-service、user-service服务。

springcloud-sleuth-eureka.png

多次调用ribbon-service接口：http://localhost:8301/user/ribbon/100

调用完后查看zipkin首页发现，已经有请求链路跟踪信息了。

springcloud-sleuth-zipkin-02.png

点击查看详情，可以直观地看到请求调用链路和通过每个服务的耗时，如下图示：

springcloud-sleuth-zipkin-03.png

springcloud-sleuth-zipkin-04.png

使用Elasticsearch存储跟踪信息

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

安装Elasticsearch

Elasticsearch下载地址：
https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2

下载Elasticsearch6.2.2的zip包，并解压到指定目录。

运行bin目录下的elasticsearch.bat启动Elasticsearch，如下图示即表示启动成功。

springcloud-sleuth-zipkin-es.png

Kibana下载地址：
https://www.elastic.co/cn/downloads/past-releases#kibana

下载Kibana，运行bin目录下的kibana.bat启动Kibana。

springcloud-sleuth-zipkin-kibana.png

Kibana访问地址：http://localhost:5601

修改启动参数将信息存储到Elasticsearch

执行以下命令重新启动zipkin，将跟踪信息持久化存储到Elasticsearch：

java -jar zipkin-server-2.12.9-exec.jar --STORAGE_TYPE=elasticsearch --ES_HOSTS=localhost:9200

说明：
STORAGE_TYPE：表示存储类型
ES_HOSTS：表示ES的访问地址

更多启动参数参考：
https://github.com/openzipkin/zipkin/tree/master/zipkin-server#elasticsearch-storage

然后，重新启动user-service和ribbon-service服务，调用ribbon-service接口：http://localhost:8301/user/ribbon/100

在Kibana中，我们可以看到存储的跟踪信息：

springcloud-sleuth-zipkin-kibana-02.png

Gitee项目源码地址：
https://gitee.com/whwtree/springcloud-learning.git

（完）