跟我学SpringCloud-第十一篇使用Spring-Cloud-Sleuth和Zipkin进行分布式链路跟踪

共计 4902 个字符，预计需要花费 13 分钟才能阅读完成。

Springboot: 2.1.6.RELEASE

SpringCloud: Greenwich.SR1

如无特殊说明，本系列教程全采用以上版本

在分布式服务架构中，需要对分布式服务进行治理——在分布式服务协同向用户提供服务时，每个请求都被哪些服务处理？在遇到问题时，在调用哪个服务上发生了问题？在分析性能时，调用各个服务都花了多长时间？哪些调用可以并行执行？…… 为此，分布式服务平台就需要提供这样一种基础服务——可以记录每个请求的调用链；调用链上调用每个服务的时间；各个服务之间的拓扑关系…… 我们把这种行为称为“分布式服务跟踪”。

现今业界分布式服务跟踪的理论基础主要来自于 Google 的一篇论文《Dapper, a Large-Scale Distributed Systems Tracing Infrastructure》，使用最为广泛的开源实现是 Twitter 的 Zipkin，为了实现平台无关、厂商无关的分布式服务跟踪，CNCF 发布了布式服务跟踪标准 Open Tracing。国内，淘宝的“鹰眼”、京东的“Hydra”、大众点评的“CAT”、新浪的“Watchman”、唯品会的“Microscope”、窝窝网的“Tracing”都是这样的系统。

一般的，一个分布式服务跟踪系统，主要有三部分：数据收集、数据存储和数据展示。根据系统大小不同，每一部分的结构又有一定变化。譬如，对于大规模分布式系统，数据存储可分为实时数据和全量数据两部分，实时数据用于故障排查（troubleshooting），全量数据用于系统优化；数据收集除了支持平台无关和开发语言无关系统的数据收集，还包括异步数据收集（需要跟踪队列中的消息，保证调用的连贯性），以及确保更小的侵入性；数据展示又涉及到数据挖掘和分析。虽然每一部分都可能变得很复杂，但基本原理都类似。

服务追踪的追踪单元是从客户发起请求（request）抵达被追踪系统的边界开始，到被追踪系统向客户返回响应（response）为止的过程，称为一个“trace”。每个 trace 中会调用若干个服务，为了记录调用了哪些服务，以及每次调用的消耗时间等信息，在每次调用服务时，埋入一个调用记录，称为一个“span”。这样，若干个有序的 span 就组成了一个 trace。在系统向外界提供服务的过程中，会不断地有请求和响应发生，也就会不断生成 trace，把这些带有 span 的 trace 记录下来，就可以描绘出一幅系统的服务拓扑图。附带上 span 中的响应时间，以及请求成功与否等信息，就可以在发生问题的时候，找到异常的服务；根据历史数据，还可以从系统整体层面分析出哪里性能差，定位性能优化的目标。

Spring Cloud Sleuth 为服务之间调用提供链路追踪。通过 Sleuth 可以很清楚的了解到一个服务请求经过了哪些服务，每个服务处理花费了多长。从而让我们可以很方便的理清各微服务间的调用关系。此外 Sleuth 可以帮助我们：

耗时分析: 通过 Sleuth 可以很方便的了解到每个采样请求的耗时，从而分析出哪些服务调用比较耗时;
可视化错误: 对于程序未捕捉的异常，可以通过集成 Zipkin 服务界面上看到;
链路优化: 对于调用比较频繁的服务，可以针对这些服务实施一些优化措施。

spring cloud sleuth 可以结合 zipkin，将信息发送到 zipkin，利用 zipkin 的存储来存储信息，利用 zipkin ui 来展示数据。

Zipkin 是一个开放源代码分布式的跟踪系统，由 Twitter 公司开源，它致力于收集服务的定时数据，以解决微服务架构中的延迟问题，包括数据的收集、存储、查找和展现。

每个服务向 zipkin 报告计时数据，zipkin 会根据调用关系通过 Zipkin UI 生成依赖关系图，显示了多少跟踪请求通过每个服务，该系统让开发者可通过一个 Web 前端轻松的收集和分析数据，例如用户每次请求服务的处理时间等，可方便的监测系统中存在的瓶颈。

Zipkin 提供了可插拔数据存储方式：In-Memory、MySql、Cassandra 以及 Elasticsearch。接下来的测试为方便直接采用 In-Memory 方式进行存储，生产推荐 Elasticsearch。

根据全球最大同性交友网站（github）搜索 zipkin 后发现，zipkin 现在已经不在推荐使用 maven 引入 jar 的方式构建了，目前推荐的方案是直接 down 他们打好包的 jar，用 java -jar 的方式启动，传送门在这里：https://github.com/openzipkin…。

The quickest way to get started is to fetch the latest released server as a self-contained executable jar. Note that the Zipkin server requires minimum JRE 8. For example:

curl -sSL https://zipkin.io/quickstart.sh | bash -s
java -jar zipkin.jar

You can also start Zipkin via Docker.

docker run -d -p 9411:9411 openzipkin/zipkin

Once the server is running, you can view traces with the Zipkin UI at http://your_host:9411/zipkin/.

If your applications aren’t sending traces, yet, configure them with Zipkin instrumentation or try one of our examples.
Check out the zipkin-server documentation for configuration details, or docker-zipkin for how to use docker-compose.

以上内容来自 zipkin 官方 github 摘录。简单解释就是可以使用 https 下载的方式下载 zipkin.jar，并使用 java -jar 的方式启动，还有一种就是使用 docker 的方式进行启动。

具体搭建过程我这里就不在赘述，有不懂的可以私信或者关注公众号留言问我。

zipkin 的启动命令就比较谜了。

最简单的启动命令为：nohup java -jar zipkin.jar >zipkin.out 2>&1 &，这时，我们使用的是 zipkin 的 In-Memory，含义是所有的数据都保存在内存中，一旦重启数据将全部清空，这肯定不是我们想要的，我们更想数据可以保存在磁盘中，可以被抽取到大数据平台上，方便我们后续的相关性能、服务状态分析、实时报警等功能。

这里我把使用 mysql 的启动语句分享出来，有关 ES 的启动语句基本相同：

STORAGE_TYPE=mysql MYSQL_DB=zipkin MYSQL_USER=name MYSQL_PASS=password MYSQL_HOST=172.19.237.44 MYSQL_TCP_PORT=3306 MYSQL_USE_SSL=false nohup java -jar zipkin.jar --zipkin.collector.rabbitmq.addresses=localhost --zipkin.collector.rabbitmq.username=username --zipkin.collector.rabbitmq.password=password --logging.level.zipkin2=DEBUG >zipkin.out 2>&1 &

注意： 因为链路追踪的数据上报量是非常大的，如果上报数据直接使用 http 请求的方式推送到 zipkin 中，很有可能会把 zipkin 服务或者数据库冲崩掉，所以我在这里增加了 rabbitmq 的相关配置，上报数据先推送至 rabbitmq 中，再由 rabbitmq 讲数据推送至 zipkin 服务，这样达到一个请求削峰填谷的作用。
有关 zipkin 的启动命令可以配置的参数可以看这里：https://github.com/apache/inc…
有关 zipkin 配置 mysql 基础建表语句可以看这里：https://github.com/apache/inc…
有关 zipkin 本身配置文件可以看这里：https://github.com/apache/inc…

至此，zipkin 服务应该已经搭建并完成，现在我们可以访问一下默认端口，看一下 zipkin-ui 具体长什么样子了。

我们先将上一篇用到的 zuul-simple、Eureka 和 producer copy 到本篇文章使用的文件夹中。

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
</dependency>

在 zuul-simple 和 producer 两个项目中增加 sleuth 和 rabbitmq 的依赖。

增加有关 rabbitmq 和 sleuth 的配置，这里我仅给出 zuul 的配置文件，producer 的配置同理。

server:
  port: 8080
spring:
  application:
    name: spring-cloud-zuul
  rabbitmq:
    host: host
    port: port
    username: username
    password: password
  sleuth:
    sampler:
      probability: 1.0
zuul:
  FormBodyWrapperFilter:
    pre:
      disable: true
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/

注：spring.sleuth.sampler.probability 的含义是链路追踪采样率，默认是 0.1，我这里为了方便测试，将其改成 1.0，意思是百分之百采样。

这里我们依次启动 Eureka、producer 和 zuul-simple。

打开浏览器，访问测试连接：http://localhost:8080/spring-cloud-producer/hello?name=spring&token=123

这时我们先看 zuul 的日志，如下图：

2019-07-07 23:09:28.529  INFO [spring-cloud-zuul,0596a362d604fb01,0596a362d604fb01,true] 20648 --- [nio-8080-exec-1] c.s.zuulsimple.filter.TokenFilter

注：这里的 0596a362d604fb01 就是这个请求的 traceID，0596a362d604fb01 是 spanID。

我们打开 zipkin-ui 的界面，如下图：

这里我们可以看到这个请求的整体耗时，点击这个请求，可以进入到详情页面，查看每个服务的耗时：

点击对应的服务，我们可以看到相应的访问时间，http 请求类型、路径、IP、tranceID、spanId 等内容，如下图：

示例代码 -Github

参考：

http://daixiaoyu.com/distribu…
http://www.ityouknow.com/spri…

1. 背景

2. Spring Cloud Sleuth

2. ZipKin

3. 快速上手

3.1 zipkin

3.1.1 zipkin 下载

3.1.2 zipkin 启动

3.2 Spring Cloud Sleuth 使用

3.2.1 增加依赖：

3.2.2 配置文件

3.2.3 测试

Just My Socks（注册教程内含优惠码）