第九章、springcloud---Spring Cloud Sleuth和Zipkin分布式链路跟踪

待我称王封你为后i 2022-04-13 08:18 228阅读 0赞

# Spring Cloud Sleuth和Zipkin分布式链路跟踪 #

本文中示例代码的引用版本：  
org.springframework.boot 版本 ：1.5.3.RELEASE  
org.springframework.cloud 版本：Camden.SR1  
说明：1004gateway-service-zuul-eureka  
org.springframework.boot 版本 ：1.5.3.RELEASE  
org.springframework.cloud 版本：Camden.SR7  
用Camden.SR1 报错：call ‘refresh’ before multicasting events via the context  
[示例代码-码云][-] [https://gitee.com/sharps/springcloud][-]

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

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

## Spring Cloud Sleuth ##

一般的，一个分布式服务跟踪系统，主要有三部分：数据收集、数据存储和数据展示。根据系统大小不同，每一部分的结构又有一定变化。譬如，对于大规模分布式系统，数据存储可分为实时数据和全量数据两部分，实时数据用于故障排查（troubleshooting），全量数据用于系统优化；数据收集除了支持平台无关和开发语言无关系统的数据收集，还包括异步数据收集（需要跟踪队列中的消息，保证调用的连贯性），以及确保更小的侵入性；数据展示又涉及到数据挖掘和分析。虽然每一部分都可能变得很复杂，但基本原理都类似。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70]  
服务追踪的追踪单元是从客户发起请求（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_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 1]

## ZipKin ##

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

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

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

## 快速上手 ##

创建zipkin-server项目

#### 1、项目依赖 ####

<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-eureka</artifactId>
    		</dependency>
    		<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-test</artifactId>
    			<scope>test</scope>
    		</dependency>

#### 2、启动类 ####

@SpringBootApplication
    @EnableEurekaClient
    @EnableZipkinServer
    public class ZipkinServerApplication { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(ZipkinServerApplication.class, args);
    	}
    }

使用了@EnableZipkinServer注解，启用Zipkin服务。

#### 3、配置文件 ####

spring.application.name=zipkin-server
    server.port=9000
    eureka.client.serviceUrl.defaultZone=http://localhost:8000/eureka/

配置完成后依次启动示例项目：1002spring-cloud-eureka、1001zipkin-server项目。刚问地址:http://localhost:9000可以看到Zipkin后台页面  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 2]

## 项目添加zipkin支持 ##

在项目1003spring-cloud-producer和1004gateway-service-zuul-eureka中添加zipkin的支持。  
1003spring-cloud-producer

<dependencies>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-eureka</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-zipkin</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>

1004gateway-service-zuul-eureka  
org.springframework.boot 版本 ：1.5.3.RELEASE  
org.springframework.cloud 版本：Camden.SR7  
用Camden.SR1 报错：call ‘refresh’ before multicasting events via the context

<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-eureka</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-zuul</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-zipkin</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>

Spring应用在监测到Java依赖包中有sleuth和zipkin后，会自动在RestTemplate的调用过程中向HTTP请求注入追踪信息，并向Zipkin Server发送这些信息。  
1003spring-cloud-producer

spring.application.name=spring-cloud-producer
    server.port=9001
    spring.sleuth.sampler.percentage=1.0
    spring.zipkin.base-url=http://localhost:9000
    eureka.client.serviceUrl.defaultZone=http://localhost:8000/eureka/

1004gateway-service-zuul-eureka

spring.application.name=gateway-service-zuul
    server.port=8888
    spring.sleuth.sampler.percentage=1.0
    spring.zipkin.base-url=http://localhost:9000
    
    zuul.routes.producer.path=/producer/**
    zuul.routes.producer.serviceId=spring-cloud-producer
    
    eureka.client.serviceUrl.defaultZone=http://localhost:8000/eureka/

spring.zipkin.base-url指定了Zipkin服务器的地址，spring.sleuth.sampler.percentage将采样比例设置为1.0，也就是全部都需要。

Spring Cloud Sleuth有一个Sampler策略，可以通过这个实现类来控制采样算法。采样器不会阻碍span相关id的产生，但是会对导出以及附加事件标签的相关操作造成影响。 Sleuth默认采样算法的实现是Reservoir sampling，具体的实现类是PercentageBasedSampler，默认的采样比例为: 0.1(即10%)。不过我们可以通过spring.sleuth.sampler.percentage来设置，所设置的值介于0.0到1.0之间，1.0则表示全部采集。

这两个项目添加zipkin之后，依次进行启动。  
进行验证  
这样我们就模拟了这样一个场景，通过外部请求访问Zuul网关，Zuul网关去调用spring-cloud-producer对外提供的服务。

四个项目均启动后，在浏览器中访问地址：[http://localhost:8888/producer/hello?name=llx][http_localhost_8888_producer_hello_name_llx] ，然后再打开地址： http://localhost:9000点击对应按钮进行查看。

点击查找看到有对应记录  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 3]  
点击记录进去页面，可以看到每一个服务所耗费的时间和顺序  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 4]  
点击依赖分析，可以看到项目之间的调用关系  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 5]  
项目节点  
10spring-cloud-sleuth-zipkin  
\---->1001zipkin-server 说明：zipkin-server  
\---->1002spring-cloud-eureka 说明：服务注册中心  
\---->1003spring-cloud-producer  
\---->1004gateway-service-zuul-eureka

[-]: https://gitee.com/sharps/springcloud
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70]: /images/20220413/11a72c013c8e41b88a3a97a617119818.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 1]: /images/20220413/c2de664b019045679d4af8c2a35d9220.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 2]: /images/20220413/f94e5415b07a4cf4bdaad185227978e6.png
[http_localhost_8888_producer_hello_name_llx]: http://localhost:8888/producer/hello?name=llx
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 3]: /images/20220413/1d648fde2e9d4db8ba04170ff78e9bb8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 4]: /images/20220413/1b0c236f48ae410092f249c8dcb240c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzQyMDE1_size_16_color_FFFFFF_t_70 5]: /images/20220413/8fac268c65724d55b20ef4cad448fd09.png