【springCloud基础篇-17】Spring Cloud Sleuth和Zipkin进行分布式链路跟踪

「爱情、让人受尽委屈。」 2023-06-19 07:25 19阅读 0赞

接上篇文章:[https://blog.csdn.net/qq\_33333654/article/details/103389470][https_blog.csdn.net_qq_33333654_article_details_103389470]

参考文献：[http://www.ityouknow.com/springcloud/2018/02/02/spring-cloud-sleuth-zipkin.html][http_www.ityouknow.com_springcloud_2018_02_02_spring-cloud-sleuth-zipkin.html]

demo代码地址：[https://download.csdn.net/download/qq\_33333654/12014918][https_download.csdn.net_download_qq_33333654_12014918]

随着业务发展，系统拆分导致系统调用链路愈发复杂一个前端请求可能最终需要调用很多次后端服务才能完成，当整个请求变慢或不可用时，我们是无法得知该请求是由某个或某些后端服务引起的，这时就需要解决如何快读定位服务故障点，以对症下药。于是就有了分布式系统调用跟踪的诞生。

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

## Spring Cloud Sleuth ##

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

![format_png][]

服务追踪的追踪单元是从客户发起请求（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来展示数据。

这是Spring Cloud Sleuth的概念图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70][]

### 创建zipkin-server项目 ###

pom文件：

>     <?xml version="1.0" encoding="UTF-8"?>
>     <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
>              xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
>         <modelVersion>4.0.0</modelVersion>
>         <parent>
>             <groupId>org.springframework.boot</groupId>
>             <artifactId>spring-boot-starter-parent</artifactId>
>             <version>1.5.3.RELEASE</version>
>             <relativePath/> 
>         </parent>
>         <groupId>com.example</groupId>
>         <artifactId>zipkin-server</artifactId>
>         <version>0.0.1-SNAPSHOT</version>
>         <name>zipkin-server</name>
>         <description>Demo project for Spring Boot</description>
>     
>         <properties>
>             <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
>             <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
>             <java.version>1.8</java.version>
>             <spring-cloud.version>Dalston.RELEASE</spring-cloud.version>
>         </properties>
>     
>         <dependencies>
>             <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.boot</groupId>
>                 <artifactId>spring-boot-starter</artifactId>
>             </dependency>
>             <dependency>
>                 <groupId>org.springframework.cloud</groupId>
>                 <artifactId>spring-cloud-starter-eureka</artifactId>
>             </dependency>
>             <dependency>
>                 <groupId>org.springframework.boot</groupId>
>                 <artifactId>spring-boot-starter-test</artifactId>
>                 <scope>test</scope>
>                 <exclusions>
>                     <exclusion>
>                         <groupId>org.junit.vintage</groupId>
>                         <artifactId>junit-vintage-engine</artifactId>
>                     </exclusion>
>                 </exclusions>
>             </dependency>
>         </dependencies>
>         <dependencyManagement>
>             <dependencies>
>                 <dependency>
>                     <groupId>org.springframework.cloud</groupId>
>                     <artifactId>spring-cloud-dependencies</artifactId>
>                     <version>${spring-cloud.version}</version>
>                     <type>pom</type>
>                     <scope>import</scope>
>                 </dependency>
>             </dependencies>
>         </dependencyManagement>
>         <build>
>             <plugins>
>                 <plugin>
>                     <groupId>org.springframework.boot</groupId>
>                     <artifactId>spring-boot-maven-plugin</artifactId>
>                 </plugin>
>             </plugins>
>         </build>
>     
>     </project>

yml文件：

>     server:
>       port: 9000
>     eureka:
>       client:
>         service-url:
>           defaultZone: http://peer1:8000/eureka/,http://peer2:8001/eureka/,http://peer3:8002/eureka/
>     spring:
>       application:
>         name: zipkin-server

启动类：

>     package com.example.zipkinserver;
>     
>     import org.springframework.boot.SpringApplication;
>     import org.springframework.boot.autoconfigure.SpringBootApplication;
>     import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
>     import zipkin.server.EnableZipkinServer;
>     
>     @EnableEurekaClient
>     @EnableZipkinServer
>     @SpringBootApplication
>     public class ZipkinServerApplication {
>     
>         public static void main(String[] args) {
>             SpringApplication.run(ZipkinServerApplication.class, args);
>         }
>     
>     }

@EnableZipkinServer是添加对zipink的支持

启动注册中心，启动rabbitmq，启动zipkin-server项目，浏览器访问：

[http://localhost:9000][http_localhost_9000]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 1][]

说明启动成功。

zuul项目添加支持：

> zuul项目pom添加：
> 
>     <dependency>
>         <groupId>org.springframework.cloud</groupId>
>         <artifactId>spring-cloud-starter-zipkin</artifactId>
>     </dependency>

zuul项目添加yml支持:

>     server:
>       port: 8888
>     eureka:
>       client:
>         service-url:
>           defaultZone: http://peer1:8000/eureka/,http://peer2:8001/eureka/,http://peer3:8002/eureka/
>     spring:
>       application:
>         name: gateway-service-zuul
>     #  cloud:
>     #    loadbalancer:
>     #      retry:
>     #        enabled: true # 开启重试
>       zipkin:
>         base-url: http://localhost:9000
>       sleuth:
>         sampler:
>           percentage: 1.0
>     zuul:
>       routes:
>         api-a:
>           path: /client/**
>           serviceId: spring-cloud-config-client
>       retryable: true # 开启重试
>     ribbon:
>     #  connectTimeout: 2000 # 请求连接的超时时间
>     #  readTimeout: 5000 # 请求处理的超时时间
>       maxAutoRetries: 2 # 对当前实例的重试次数
>       maxAutoRetriesNextServer: 0 # 切换实例的重试次数
>     #  okToRetryOnAllOperations: false # 对所有操作请求都进行重试
>     
>     
>     
>     #    hello:
>     #      path: /hello/**
>     #      url: http://localhost:9031/
>     
>     #    baidu:
>     #      path: /it/**
>     #      url: https://blog.csdn.net/qq_33333654/category_9436879.html

spring-cloud-config-client项目添加zipkin支持：

pom文件：

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

> 修改bootstrap.yml文件：
> 
>     spring:
>       zipkin:
>         base-url: http://localhost:9000
>         sleuth:
>           sampler:
>             percentage: 1.0
>       cloud:
>         config:
>           discovery:
>             enabled: true
>             serviceId: spring-cloud-config-server   #      uri: http://localhost:9021/
>           name: native
>           profile: mysql
>           lable: master
>     eureka:
>       client:
>         service-url:
>           defaultZone: http://peer1:8000/eureka/,http://peer2:8001/eureka/,http://peer3:8002/eureka/

特别注意，这里必须添加到bootstrap.yml文件中，最好是放到上面。不然会报错Error starting ApplicationContext. To display the auto-configuration report re-run your application with 'debug' enabled.

接下来一次启动:

spring-cloud-config-server项目、

spring-cloud-config-client项目、

zuul项目。

注意浏览器访问前清理下缓存。

浏览器访问[http://localhost:8888/client/testZuul?token=xxx][http_localhost_8888_client_testZuul_token_xxx]

多次访问后，浏览器打开[http://localhost:9000][http_localhost_9000]

点击按钮，如图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 2][]

追踪结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 3][]

查看追踪图谱，点击如图按钮：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 4][]

完成。

[https_blog.csdn.net_qq_33333654_article_details_103389470]: https://blog.csdn.net/qq_33333654/article/details/103389470
[http_www.ityouknow.com_springcloud_2018_02_02_spring-cloud-sleuth-zipkin.html]: http://www.ityouknow.com/springcloud/2018/02/02/spring-cloud-sleuth-zipkin.html
[https_download.csdn.net_download_qq_33333654_12014918]: https://download.csdn.net/download/qq_33333654/12014918
[Dapper_ a Large-Scale Distributed Systems Tracing Infrastructure]: https://research.google.com/pubs/pub36356.html
[format_png]: https://imgconvert.csdnimg.cn/aHR0cDovL2Zhdm9yaXRlcy5yZW4vYXNzZXRzL2ltYWdlcy8yMDE4L3NwcmluZ2Nsb3VkL3RyYWNpbmcxLnBuZw?x-oss-process=image/format,png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191205113715968.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0,size_16,color_FFFFFF,t_70
[http_localhost_9000]: http://localhost:9000/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191205113935905.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0,size_16,color_FFFFFF,t_70
[http_localhost_8888_client_testZuul_token_xxx]: http://localhost:8888/client/testZuul?token=xxx
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191205114744204.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191205114800582.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20191205114827135.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMzNjU0,size_16,color_FFFFFF,t_70