Spring Cloud整合Zipkin进行服务跟踪

た入场券 2024-03-30 09:32 51阅读 0赞

Zipkin 是 Twitter 的一个开源项目，是一个致力于收集所有服务的监控数据的分布式跟踪系统，它提供了收集数据和查询数据两大接口服务。有了 Zipkin 我们就可以很直观地对调用链进行查看，并且可以很方便地看出服务之间的调用关系以及调用耗费的时间。

### Zipkin 数据收集服务 ###

部署 Zipkin 需要先下载已经编译好了的 jar 包，然后 java–jar 启动即可。

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

启动后访问 http://localhost:9411/zipkin/ 就可以看到管理页面了，如图 1 所示。

![4b786e79c3a84c7bac4f3c7782a83692.png][]  
图 1 Zipkin 后台管理

### 项目集成 Zipkin 发送调用链数据 ###

在前面的教程中，我们只是集成了 Spring Cloud Sleuth，然后将跟踪信息输出到日志中。现在，Zipkin 的服务部署好了，需要将链路跟踪的信息发送给 Zipkin 的收集服务。

需要在项目中添加依赖，具体代码如下所示。

> 1.  `<dependency>`
> 2.  `<groupId>org.springframework.cloud</groupId>`
> 3.  `<artifactId>spring-cloud-starter-zipkin</artifactId>`
> 4.  `</dependency>`

在属性文件中可以配置 Zipkin 的地址，默认是 http://127.0.0.1:9411，这样才能将跟踪的数据发送到执行的收集服务中。

> 1.  `# 配置 zipKin Server 的地址`
> 2.  `spring.zipkin.base-url=http://127.0.0.1:9411`

然后我们启动之前的服务、访问接口，就可以看到数据已经能够在 Zipkin 的 Web 页面中了，如图 2 和图 3 所示。

![2f758960b273a25b6f1e9cdb8019bc19.png][]

图 2 Zipkin 链路列表

![4c56eb7ffeea4314a7ab569058380eb9.png][]  
图 3 Zipkin 链路详情

停掉被访问的服务，模拟一下异常情况，通过 Zipkin 的 UI 可以快速发现请求异常的信息，如图 4 所示。

![f39c18a30f744dfabf1cd01f2b329485.png][]  
图 4 Zipkin 异常请求

还可以查询异常的详细信息，如图 5 所示。

![c8ca17e5f3144481a828ac13f5abe6df.png][]  
图 5 Zipkin 链路异常信息详情

### 抽样采集数据 ###

在实际使用中可能调用了 10 次接口，但是 Zipkin 中只有一条数据，这是因为收集信息是有一定比例的，这并不是 bug。Zipkin 中的数据条数与调用接口次数默认比例是 0.1，当然我们也可以通过配置来修改这个比例值：

> 1.  `#zipkin 抽样比例`
> 2.  `spring.sleuth.sampler.probability=1.0`

之所以有这样的一个配置，是因为在高并发下，如果所有数据都采集，那这个数据量就太大了，采用抽样的做法可以减少一部分数据量，特别是对于 Http 方式去发送采集数据，对性能有很大的影响。

### 异步任务线程池定义 ###

Sleuth 对异步任务也是支持的，我们用 @Async 开启一个异步任务后，Sleuth 会为这个调用新创建一个 Span。

如果你自定义了异步任务的线程池，会导致无法新创建一个 Span，这就需要使用 Sleuth 提供的 LazyTraceExecutor 来包装下。代码如下所示。

> 1.  `@Configuration`
> 2.  `@EnableAutoConfiguration`
> 3.  `public class CustomExecutorConfig extends AsyncConfigurerSupport {`
> 4.  `@Autowired`
> 5.  `BeanFactory beanFactory;`
> 6.  `@Override`
> 7.  `public Executor getAsyncExecutor() {`
> 8.  `ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();`
> 9.  `executor.setCorePoolSize(7);`
> 10. `executor.setMaxPoolSize(42);`
> 11. `executor.setQueueCapacity(11);`
> 12. `executor.setThreadNamePrefix("zhangsan-");`
> 13. `executor.initialize();`
> 14. `return new LazyTraceExecutor(this.beanFactory, executor);`
> 15. `}`
> 16. `}`

如果直接 return executor 就不会新建 Span，也就不会有 save-log 这个 Span。如图 6 所示。

![a86491638120440ebd00ecc08d089d1a.png][]  
图 6 Zipkin Span 信息

### TracingFilter ###

TracingFilter 是负责处理请求和响应的组件，我们可以通过注册自定义的 TracingFilter 实例来实现一些扩展性的需求。下面给大家演示下如何给请求添加自定义的标记以及将请求 ID 添加到响应头返回给客户端。代码如下所示。

> 1.  `@Component`
> 2.  `@Order(TraceWebServletAutoConfiguration.TRACING_FILTER_ORDER + 1)`
> 3.  `class MyFilter extends GenericFilterBean {`
> 4.  `private final Tracer tracer;`
> 5.  `MyFilter(Tracer tracer) {`
> 6.  `this.tracer = tracer;`
> 7.  `}`
> 8.  `@Override`
> 9.  `public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)`
> 10. `throws IOException, ServletException {`
> 11. `Span currentSpan = this.tracer.currentSpan();`
> 12. `if (currentSpan == null) {`
> 13. `chain.doFilter(request, response);`
> 14. `return;`
> 15. `}`
> 16. `((HttpServletResponse) response).addHeader("ZIPKIN-TRACE-ID", currentSpan.context().traceIdString());`
> 17. `currentSpan.tag("custom", "tag");`
> 18. `chain.doFilter(request, response);`
> 19. `}`
> 20. `}`

我们在响应头中设置了请求 ID，可以通过查看请求的响应信息来验证是否设置成功，如图 7 所示。

![3e9429f61d9d4e59a81361c782198dca.png][]  
图 7 查询请求响应信息

手动创建的标记可以在 Zipkin 中查看，如图 8 所示。

![81a7976dea0f119bda6df32db751df34.gif][]

图 8 Zipkin 自定义标记信息

自定义标记是一个非常实用的功能，可以将请求对应的用户信息标记上去，排查问题时非常有帮助。

### 监控本地方法 ###

异步执行和远程调用都会新开启一个 Span，如果我们想监控本地的方法耗时时间，可以采用埋点的方式监控本地方法，也就是开启一个新的 Span。代码如下所示。

> 1.  `@Autowired`
> 2.  `Tracer tracer;`
> 3.  `@Override`
> 4.  `public void saveLog2(String log) {`
> 5.  `ScopedSpan span = tracer.startScopedSpan("saveLog2");`
> 6.  `try {`
> 7.  `Thread.sleep(2000);`
> 8.  `} catch (Exception | Error e) {`
> 9.  `span.error(e);`
> 10. `} finally {`
> 11. `span.finish();`
> 12. `}`
> 13. `}`

通过手动埋点的方式可以创建新的 Span，在 Zipkin 的 UI 中也可以看到这个本地方法执行所消耗的时间，可以看到 savelog2 花费了 2 秒的时间，如图 9 所示。

![354fddb269304cfc84d9443ac9fab8d0.png][]  
图 9 Zipkin 手动埋点数据信息

除了使用代码手动创建 Span，还有一种更简单的方式，那就是在方法上加上下面的注解：

> 1.  `@NewSpan(name = "saveLog2")`

### 过滤不想跟踪的请求 ###

对于某些请求不想开启跟踪，可以通过配置 HttpSampler 来过滤掉，比如 swagger 这些请求等。代码如下所示。

> 1.  `@Bean(name = ServerSampler.NAME)`
> 2.  `HttpSampler myHttpSampler(SkipPatternProvider provider) {`
> 3.  `Pattern pattern = provider.skipPattern();`
> 4.  `return new HttpSampler() {`
> 5.  `@Override`
> 6.  `public <Req> Boolean trySample(HttpAdapter<Req, ?> adapter, Req request) {`
> 7.  `String url = adapter.path(request);`
> 8.  `boolean shouldSkip = pattern.matcher(url).matches();`
> 9.  `if (shouldSkip) {`
> 10. `return false;`
> 11. `}`
> 12. `return null;`
> 13. `}`
> 14. `};`
> 15. `}`

核心在 trySample 方法中，只要不想跟踪的 URL 直接返回 false 就可以过滤。规则可以自定，笔者用了 SkipPatternProvider 来过滤，SkipPatternProvider 中的 skipPattern 配置了很多过滤规则。

### 用RabbitMq代替Http发送调用链数据 ###

虽然有基于采样的收集方式，但是数据的发送采用 Http 还是对性能有影响。如果 Zipkin 的服务端重启或者挂掉了，那么将丢失部分采集数据。为了解决这些问题，我们将集成 RabbitMq 来发送采集数据，利用消息队列来提高发送性能，保证数据不丢失。

在服务中增加 RabbitMq 的依赖：

> 1.  `<dependency>`
> 2.  `<groupId>org.springframework.amqp</groupId>`
> 3.  `<artifactId>spring-rabbit</artifactId>`
> 4.  `</dependency>`

然后在属性文件中增加 RabbitMq 的连接配置：

> 1.  `# 修改zipkin的数据发送方式为RabbitMq`
> 2.  `spring.zipkin.sender.type=RABBIT`
> 3.  `# rabbitmq 配置`
> 4.  `spring.rabbitmq.addresses=amqp://192.168.10.124:5672`
> 5.  `spring.rabbitmq.username=zhangsan`
> 6.  `spring.rabbitmq.password=123456`

到这里，集成就已经完成了，记得去掉之前配置的 spring.zipkin.base-url。因为我们现在利用 RabbitMq 来发送数据了，所以这个配置就不需要了。

数据发送方已经采用 RabbitMq 来发送调用链数据，但是 Zipkin 服务并不知道 RabbitMq 的信息，所以我们在启动 Zipkin 服务的时候需要指定 RabbitMq 的信息。

> 1.  `java -DRABBIT_ADDRESSES=192.168.10.124:5672 - DRABBIT_USER=zhangsan -DRABBIT_PASSWORD=123456 -jar zipkin.jar`

### 用Elasticsearch存储调用链数据 ###

目前我们收集的数据都是存在 Zipkin 服务的内存中，服务一重启这些数据就没了，我们需要将这些数据持久化。我们可以将其存储在 MySQL 中，实际使用中数据量可能会比较大，所以 MySQL 并不是一种很好的选择，可以选择用 Elasticsearch 来存储数据，Elasticsearch 在搜索方面有先天的优势。

启动 Zipkin 的时候指定存储类型为 ES，指定 ES 的 URL 信息：

> 1.  `java -DSTORAGE_TYPE=elasticsearch -DES_HOSTS=http://localhost:9200 - DRABBIT_ADDRESSES=192.168.10.124:5672 -DRABBIT_USER=zhangsan -DRABBIT_PASSWORD=123456 -jar zipkin.jar`

重启服务，然后收集一些数据，我们可以通过两种方式来验证数据是否存储到了 Elasticsearch 中。

可以重启 Zipkin 服务，然后看看数据是否还存在，如果存在则证明数据已经是持久化了。

可以通过查看 Elasticsearch 中的数据来确认数据有没有存储成功，访问 Elasticsearch 的地址查看当前所有的索引信息：http://localhost：9200/\_cat/indices。

> 1.  `yellow open zipkin:span-2019-01-22 P0QTytShTWmAyZVg61dmRg 5 1 5 0 33.6kb 33.6kb`

可以看到当前节点下面有哪些索引，如果看到有以 zipkin 开头的就说明索引创建了，接着直接查询这个索引下是否有数据即可认证是否存储成功，访问 http://localhost：9200/索引名称/\_search。

[4b786e79c3a84c7bac4f3c7782a83692.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/38556515072c4f1ea384274f64eadcf9.png
[2f758960b273a25b6f1e9cdb8019bc19.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/6c659e984d694f77be266ec22f82167e.png
[4c56eb7ffeea4314a7ab569058380eb9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/11e54d97668e4ef7a0de26e75533d65a.png
[f39c18a30f744dfabf1cd01f2b329485.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/7a208cb468074e859fccd382187ae5d1.png
[c8ca17e5f3144481a828ac13f5abe6df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/51f475fef3ee404ea3a1e6d2f2cb4d5b.png
[a86491638120440ebd00ecc08d089d1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/3b49555a953f42b8be72d4007101e725.png
[3e9429f61d9d4e59a81361c782198dca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/a76043445bca407f9815d463517ec893.png
[81a7976dea0f119bda6df32db751df34.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/a7be3f9948dc495193676d53d95dc9df.gif
[354fddb269304cfc84d9443ac9fab8d0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/6e1a9dc72190430ba837b9e9a3316457.png