Spring Cloud构建微服务架构：分布式服务跟踪（整合zipkin）【Dalston版】

今天药忘吃喽~ 2021-12-04 07:19 306阅读 0赞

通过上一篇[《分布式服务跟踪（整合logstash）》][logstash]，我们虽然已经能够利用ELK平台提供的收集、存储、搜索等强大功能，对跟踪信息的管理和使用已经变得非常便利。但是，在ELK平台中的数据分析维度缺少对请求链路中各阶段时间延迟的关注，很多时候我们追溯请求链路的一个原因是为了找出整个调用链路中出现延迟过高的瓶颈源，亦或是为了实现对分布式系统做延迟监控等与时间消耗相关的需求，这时候类似ELK这样的日志分析系统就显得有些乏力了。对于这样的问题，我们就可以引入Zipkin来得以轻松解决。

### Zipkin简介 ###

Zipkin是Twitter的一个开源项目，它基于Google Dapper实现。我们可以使用它来收集各个服务器上请求链路的跟踪数据，并通过它提供的REST API接口来辅助我们查询跟踪数据以实现对分布式系统的监控程序，从而及时地发现系统中出现的延迟升高问题并找出系统性能瓶颈的根源。除了面向开发的API接口之外，它也提供了方便的UI组件来帮助我们直观的搜索跟踪信息和分析请求链路明细，比如：可以查询某段时间内各用户请求的处理时间等。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70]  
上图展示了Zipkin的基础架构，它主要有4个核心组件构成：

*  Collector：收集器组件，它主要用于处理从外部系统发送过来的跟踪信息，将这些信息转换为Zipkin内部处理的Span格式，以支持后续的存储、分析、展示等功能。
 *  Storage：存储组件，它主要用于存储“收集器”接收到的跟踪信息，默认会将这些信息存储在内存中，我们也可以修改此存储策略，通过使用其他存储组件将跟踪信息存储到数据库中。
 *  RESTful API：API组件，它主要用来提供外部访问接口。比如给客户端展示跟踪信息，或是外接系统访问以实现监控等。
 *  Web UI：UI组件，基于API组件实现的上层应用。通过UI组件用户可以方便而有直观地查询和分析跟踪信息。

### HTTP收集 ###

在Spring Cloud Sleuth中对Zipkin的整合进行了自动化配置的封装，所以我们可以很轻松的引入和使用它，下面我们来详细介绍一下Sleuth与Zipkin的基础整合过程。主要分为两步：

**第一步：搭建Zipkin Server**

*  创建一个基础的Spring Boot应用，命名为`zipkin-server`，并在`pom.xml`中引入Zipkin Server的相关依赖，具体如下：

<parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.10.RELEASE</version>
      <relativePath/>
    </parent>
    <dependencies>
      <dependency>
      	<groupId>io.zipkin.java</groupId>
      	<artifactId>zipkin-server</artifactId>
      </dependency>
      <dependency>
      	<groupId>io.zipkin.java</groupId>
      	<artifactId>zipkin-autoconfigure-ui</artifactId>
      </dependency>
    </dependencies>
    <dependencyManagement>
      <dependencies>
      	<dependency>
      		<groupId>org.springframework.cloud</groupId>
      		<artifactId>spring-cloud-dependencies</artifactId>
      		<version>Dalston.SR5</version>
      		<type>pom</type>
      		<scope>import</scope>
      	</dependency>
      </dependencies>
    </dependencyManagement>

*  创建应用主类`ZipkinApplication`，使用`@EnableZipkinServer`注解来启动Zipkin Server，具体如下：

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

*  在`application.properties`中做一些简单配置，比如：设置服务端口号为`9411`（客户端整合时候，自动化配置会连接`9411`端口，所以在服务端设置了端口为`9411`的话，客户端可以省去这个配置）。

spring.application.name=zipkin-server
    server.port=9411

创建完上述工程之后，我们将其启动起来，并访问`http://localhost:9411/`，我们可以看到如下图所示的Zipkin管理页面：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 1]  
**第二步：为应用引入和配置Zipkin服务**

在完成了Zipkin Server的搭建之后，我们还需要对应用做一些配置，以实现将跟踪信息输出到Zipkin Server。我们以之前实现的`trace-1`和`trace-2`为例，对它们做以下改造内容：

*  在`trace-1`和`trace-2`的`pom.xml`中引入`spring-cloud-sleuth-zipkin`依赖，具体如下所示。 (**注意：** 在trace-1和trace-2里面要去掉logstash的依赖，不然的话，日志信息就会打到logstash上去了。而我们想要把日志信息打到Zipkin上，所以必须去掉logstash的依赖)

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

*  在`trace-1`和`trace-2`的`application.properties`中增加Zipkin Server的配置信息，具体如下所示（如果在`zip-server`应用中，我们将其端口设置为`9411`，并且均在本地调试的话，该参数也可以不配置，因为默认值就是`http://localhost:9411`）。

spring.zipkin.base-url=http://localhost:9411

**测试与分析**

到这里我们已经完成了接入Zipkin Server的所有基本工作，我们可以继续将`eureka-server`、`trace-1`和`trace-2`启动起来，然后我们做一些测试实验，以对它的运行机制有一些初步的理解。

我们先来向`trace-1`的接口发送几个请求：`http://localhost:9101/trace-1`，当我们在日志中出现跟踪信息的最后一个值为`true`的时候，说明该跟踪信息会输出给Zipkin Server，所以此时我们可以去Zipkin Server的管理页面中选择合适的查询条件后，点击`Find Traces`，就可以查询出刚才在日志中出现的跟踪信息了（也可以根据日志中的Trace ID，在页面的右上角输入框中来搜索），具体如下页面所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 2]  
点击下方`trace-1`端点的跟踪信息，我们还可以得到Sleuth收集到的跟踪到详细信息，其中包括了我们关注的请求时间消耗等。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 4]  
点击导航栏中的`Dependencies`菜单，我们还可以查看Zipkin Server根据跟踪信息分析生成的系统请求链路依赖关系图：  
![在这里插入图片描述][20190718103656325.png]

### 消息中间件收集 ###

Spring Cloud Sleuth在整合Zipkin时，不仅实现了以HTTP的方式收集跟踪信息，还实现了通过消息中间件来对跟踪信息进行异步收集的封装。通过结合Spring Cloud Stream，我们可以非常轻松地让我们自己做的系统 将跟踪信息输出到消息中间件上，同时Zipkin服务端从消息中间件上异步地消费这些跟踪信息。

接下来，我们基于之前实现的`trace-1`和`trace-2`应用以及`zipkin-server`服务端做一些改造，以实现通过消息中间件来收集跟踪信息。改造的内容非常简单，只需要我们做项目依赖和配置文件做一些调整就能马上实现，下面我们分别对客户端和服务端的改造内容做详细说明：

**第一步：修改客户端`trace-1`和`trace-2`**

与上一节中的配置一样，客户端的配置也非常简单，maven依赖只需要将原来的spring-cloud-starter-zipkin替换为如下两个依赖即可

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

仅仅添加上面那两个依赖是不够的，你还要将之前用http方式实现收集的依赖去掉，否则会冲突，项目起不来

把这个注掉以后项目能运行了(trace-1和trace-2都要注掉)

*  在`application.properties`配置中去掉HTTP方式实现时使用的`spring.zipkin.base-url`参数，并根据实际部署情况，增加消息中间件的相关配置，比如下面这些关于RabbitMQ的配置信息：

spring.rabbitmq.host=localhost
    spring.rabbitmq.port=5672
    spring.rabbitmq.username=springcloud       //username和password填自己的
    spring.rabbitmq.password=123456

**第二步：修改zipkin-server服务端**  
要将http方式改为通过MQ通信，我们要将依赖的原来依赖的io.zipkin.java:zipkin-server换成spring-cloud-sleuth-zipkin-stream和spring-cloud-starter-stream-rabbit，因为spring-cloud-sleuth-zipkin-stream会自动为我们引入，全部maven依赖如下：

<dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
            
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-sleuth-zipkin-stream</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
            </dependency>
            <dependency>
                <groupId>io.zipkin.java</groupId>
                <artifactId>zipkin-autoconfigure-ui</artifactId>
                <scope>runtime</scope>
            </dependency>
        </dependencies>

添加以上maven依赖后，我们将启动类ZipkinServer中@EnableZipkinServer注解替换成@EnableZipkinStreamServer

修改为如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 5]  
刚开始用http方式收集用的是`@EnableZipkinServer`注解，后来用消息代理收集，就要改成`@EnableZipkinStreamServer`注解

由于使用了消息中间件rabbit-mq，所以我们还需要在配置文件中配置我们的MQ连接配置

#rabbitmq配置
    spring.rabbitmq.host=localhost
    spring.rabbitmq.port=5672
    spring.rabbitmq.username=springcloud
    spring.rabbitmq.password=123456

为了避免http通信的干扰，我们将原来的监听端口有9411更改为9412，启动程序，未报错且能够看到rabbit连接日志，说明程序启动成功。

## 问题bug: ##

[Spring Cloud Sleuth与Zipkin整合时遇到的问题记录][Spring Cloud Sleuth_Zipkin]

**测试与分析**

在完成了上述改造内容之后，我们继续将`eureka-server`、`trace-1`和`trace-2`、`zipkin-server`都启动起来，同时确保RabbitMQ也处于运行状态。此时，我们可以在RabbitMQ的控制页面中看到一个名为`sleuth`的交换器，它就是zipkin的消息中间件收集器实现使用的默认主题。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 6]  
最后，我们使用之前的验证方法，通过向`trace-1`的接口发送几个请求：`http://localhost:9101/trace-1`，当有被抽样收集的跟踪信息时（调试时我们可以设置`AlwaysSampler`抽样机制来让每个跟踪信息都被收集），我们可以在RabbitMQ的控制页面中发现有消息被发送到了`sleuth`交换器中，同时我们再到zipkin服务端的Web页面中也能够搜索到相应的跟踪信息，那么我们使用消息中间件来收集跟踪信息的任务到这里就完成了。

本文转载自：  
[http://blog.didispace.com/spring-cloud-starter-dalston-8-4/][http_blog.didispace.com_spring-cloud-starter-dalston-8-4]

[logstash]: https://blog.csdn.net/qq_40241957/article/details/96335019
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70]: /images/20211204/086cd48b78664c02915ed0f0037be9fd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 1]: /images/20211204/7671f4e6369247a18bbe74729f905aa6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 2]: /images/20211204/16d7829bf2d943babe196db2c078ba48.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 3]: /images/20211204/70abe724815c4c87a376b604361b33c6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 4]: /images/20211204/95e413c18a304b8f8dbc86929a6e2323.png
[20190718103656325.png]: /images/20211204/4abdd14e6b844067a5f2f329cbf6077c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 5]: /images/20211204/8fe351d91ee845d6919c3f44beb48977.png
[Spring Cloud Sleuth_Zipkin]: https://blog.csdn.net/qq_40241957/article/details/96428510
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjQxOTU3_size_16_color_FFFFFF_t_70 6]: /images/20211204/733f3a5c970c454fb74199aa63acbb95.png
[http_blog.didispace.com_spring-cloud-starter-dalston-8-4]: http://blog.didispace.com/spring-cloud-starter-dalston-8-4/