spring cloud 入门系列八：使用spring cloud sleuth整合zipkin进行服务链路追踪

拼搏现实的明天。 2022-05-18 02:42 207阅读 0赞

好久没有写博客了，主要是最近有些忙，今天忙里偷闲来一篇。

=======我是华丽的分割线==========

微服务架构是一种分布式架构，微服务系统按照业务划分服务单元，一个微服务往往会有很多个服务单元，一个请求往往会有很多个单元参与，一旦请求出现异常，想要去定位问题点真心不容易，因此需要有个东西去跟踪请求链路，记录一个请求都调用了哪些服务单元，调用顺序是怎么样的以及在各个服务单元处理的时间长短。常见的服务链路追踪组件有google的dapper、twitter的zipkin、阿里的鹰眼等，它们都是出众的开源链路追踪组件。

spring cloud 有自己的组件来集成这些开源组件，它就是spring cloud sleuth，它为服务链路追踪提供了一套完整的解决方案。

今天的主题就是如何使用spring cloud sleuth整合zipkin进行服务链路追踪。本博客将围绕下面的线索进行展开：

1.  Server端代码实现
2.  Client端代码实现
3.  执行测试

由上面的线索可以发现，zipkin分服务端和客户端。

客户端就是我们的服务单元，用来发送链路信息到服务端；

服务端用来接收客户端发送来的链路信息，并进行处理，它包括4个部分：

*  Collector组件：用来接收客户端发送的链路信息然后整理成zipkin能处理的格式，供后续存储或向外部提供查询使用。
 *  Storage组件：对链路信息进行保存，默认存储在内存，通过配置还可以保存到mysql等地方。
 *  Restful API组件：对其他服务单元提供api接口进行查询链路信息。
 *  Web UI组件：调用API 组件的接口并将信息显示到web 画面。

废话不多说，直接上代码。

**一、Server端代码实现**

先给出代码结构：

![1345071-20180719172814154-1051497117.png][]

结构比较简单，搭建过程如下：

1.  新建maven工程sleuth-zipkin
2.  修改pom文件
    
    ![复制代码][copycode.gif]
    
        <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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
            <modelVersion>4.0.0</modelVersion>
            <groupId>com.sam</groupId>
            <artifactId>sleuth-zipkin</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        
            <parent>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>1.5.1.RELEASE</version>
            </parent>
        
            <properties>
                <javaVersion>1.8</javaVersion>
            </properties>
            
            <dependencyManagement>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework.cloud</groupId>
                        <artifactId>spring-cloud-dependencies</artifactId>
                        <version>Camden.SR6</version>
                        <type>pom</type>
                        <scope>import</scope>
                    </dependency>
                </dependencies>
        
            </dependencyManagement>
        
            <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.cloud</groupId>
                    <artifactId>spring-cloud-starter-eureka</artifactId>
                </dependency>
                
            </dependencies>
        </project>
    
    ![复制代码][copycode.gif]
    
     
3.  新建启动类
    
    ![复制代码][copycode.gif]
    
        /**
         * @EnableZipkinServer
         * 
         * 用于开启Zipkin Server功能
         *
         */
        @EnableZipkinServer
        @SpringBootApplication
        @EnableDiscoveryClient
        public class SleuthZipkinApp {
        
            public static void main(String[] args) {
                SpringApplication.run(SleuthZipkinApp.class, args);
            }
        
        }
    
    ![复制代码][copycode.gif]
    
     
4.  新建配置文件
    
        server.port=9411
        spring.application.name=sleuth-zipkin
        #需要使用到eureka服务注册中心
        eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka

**二、Client端代码实现**

这里我们准备使用前面的随笔中已经实现好的微服务（[网关服务api-gateway][api-gateway]、[消费者hello-consumer和生产者hello-server][hello-consumer_hello-server]，可以点击链接查看搭建过程，这里就不详细描述了）。在这几个微服务中都做如下修改：

1.  引入依赖
    
        
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-zipkin</artifactId>
                </dependency>
    
     
2.  修改配置文件，追加两项配置
    
        #指定zipkin服务端的url
        spring.zipkin.base-url=http://localhost:9411
        #设定样本收集的比率为100%
        spring.sleuth.sampler.percentage=1.0
    
    由于分布式系统的请求量一般比较大，不可能把所有的请求链路进行收集整理，因此sleuth采用抽样收集的方式，设定一个抽样百分比。在开发阶段，我们一般设定百分比为100%也就是1。

**三、执行测试**

1.  依次启动微服务：服务注册中心eureka、zipkin服务端sleuth-zipkin、网关服务api-gateway、消费者hello-consumer和生产者hello-server
2.  访问http://localhost:1111/,确认4个微服务已经成功注册到了服务注册中心![1345071-20180719180036216-116994565.png][]
    
     
3.  访问http://localhost:5555/hello-consumer/hello-consumer?accessToken=111，通过zuul 网关进行访问，![1345071-20180719180835457-636302979.png][]
    
    查看api-gateway控制台：
    
        2018-07-19 18:02:34.999  INFO [api-gateway,4c384ab23da1ae35,4c384ab23da1ae35,true] 9296 --- [nio-5555-exec-3] com.sam.filter.AccessFilter              : send GET request to http://localhost:5555/hello-consumer/hello-consumer
        2018-07-19 18:02:45.088  INFO [api-gateway,,,] 9296 --- [trap-executor-0] c.n.d.s.r.aws.ConfigClusterResolver      : Resolving eureka endpoints via configuration
    
    请看红字部分，有4部分，以逗号分隔。第一部分是服务名；第二部分是TranceId，每次请求都会有唯一的tranceId；第三部分是spanId，每个工作单元发送一次请求就会产生一个spanId，每个请求会产生一个tranceId和多个spanId，根据tranceId和spanId就能分析出一个完整的请求都经历了哪些服务单元；第四部分是boolean型的，用来标记是否需要将该请求链路进行抽样收集发送到zipkin等进行整理。
4.  访问zipkin服务端http://localhost:9411/，查看UI页面![1345071-20180719181110742-190973289.png][]
    
    选择api-gateway，然后点击 "Find Trances"![1345071-20180719181316471-1462246682.png][]
    
    能看到请求都经历了哪些服务节点。再点相关link，可以查看调用顺序，并且还能看到在各个服务节点的处理的时间长度。![1345071-20180719181405190-1145035113.png][]
    
    切换到依赖画面，能查看服务节点的依赖关系![1345071-20180719181548788-1105127410.png][]

[1345071-20180719172814154-1051497117.png]: /images/20220518/b6fae71cf91f4cf49785823ab8f2ebaf.png
[copycode.gif]: /images/20220518/3fa89a93cb24488d81f9751a7b78ee7c.png
[api-gateway]: http://www.cnblogs.com/sam-uncle/p/9011400.html
[hello-consumer_hello-server]: http://www.cnblogs.com/sam-uncle/p/8954401.html
[1345071-20180719180036216-116994565.png]: /images/20220518/498c15ee52ab4bac98c79dafee5dc32a.png
[1345071-20180719180835457-636302979.png]: /images/20220518/acba8ffdc2ba4f97a1292bdc5629fa19.png
[1345071-20180719181110742-190973289.png]: /images/20220518/3238cdb9133a47d5a52ee975f6483f85.png
[1345071-20180719181316471-1462246682.png]: /images/20220518/a76db48c926e41f2be70b2c249ec7dba.png
[1345071-20180719181405190-1145035113.png]: /images/20220518/d682413e280441b1b9e8f99ed640b87a.png
[1345071-20180719181548788-1105127410.png]: /images/20220518/79d32bf0bae34570a0f86cb4a1fe60cc.png