基于sleuth和zipkin的Spring-Cloud链路跟踪

悠悠 2022-03-25 16:44 255阅读 0赞

# 基于sleuth和zipkin的Spring-Cloud链路跟踪 #

### 文章目录 ###

*  基于sleuth和zipkin的Spring-Cloud链路跟踪
 *   *  Sleuth
     *  Zipkin
     *  Zipkin-Server
     *  Zipkin-Client
     *  Zipkin-Ui

## Sleuth ##

*  `sleuth`借鉴了`google dapper`的思路，所以`sleuth`的原理和`dapper`几乎一样。
 *  
 *  `google dapper`原文档：[Dapper, a Large-Scale Distributed Systems Tracing Infrastructure][Dapper_ a Large-Scale Distributed Systems Tracing Infrastructure]，需科学上网。
 *  `google dapper`文档翻译：[Dapper，大规模分布式系统的跟踪系统][Dapper]。
 *  `sleuth`在`spring cloud`中体现为[Spring Cloud Sleuth][](`spring-cloud-starter-sleuth`)。
 *  `sleuth`会默认收集很多组件的`Span`信息，可以在这里 [Integrations][] 查看有哪些组件的`Span`信息会被采集，当然可以在配置里关闭。
 *  如果想要自定义`Span`，比如想把一个完全不在默认集成列表里的组件添加到监控中，可以看这里 [Managing Spans with Annotations][] 自定义`Span`。

## Zipkin ##

*  `zipkin`同样是基于`google dapper paper`实现的，也是一个分布式链路跟踪系统。
 *  `zipkin`可以分析`Sleuth`收集的`Span`信息，做一个链路、错误和依赖关系的可视化。
 *  除了`zipkin`以外，还可以自己通过其他日志采集和分析系统自定义处理方式，比如`logback+Logstash+Kibana`。

`slueth`默认通过`HTTP`将`Span`信息发送到`zipkin`，可以依赖`Kafka`、`rabbitMQ`等消息中间件自动化配置，达到通过消息中间件发送到`zipkin`的目的，以减少链路跟踪系统对业务服务的压力。

*  `sleuth`默认配置中，一个`Span`被发送到`Zipkin`的几率只有10%(0.1)，这个配置可以修改。

## Zipkin-Server ##

跟`eureka-server`类似，每个客户端服务必须把自己的`Span`信息主动发送到`Zipkin`，因此第一步先搭建一个`zipkin-server`提供给希望被采集`Span`的服务使用。

*  `pom.xml`
    
        <?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
            <modelVersion>4.0.0</modelVersion>
         
            <groupId>com.enmo.dbaas</groupId>
            <artifactId>dbaas-zipkin-server</artifactId>
            <version>1.0-SNAPSHOT</version>
         
            <name>dbaas-zipkin-server</name>
            <url>http://www.example.com</url>
         
            <parent>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>1.5.10.RELEASE</version>
                <relativePath/> 
            </parent>
         
            <properties>
                <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
                <maven.compiler.source>1.8</maven.compiler.source>
                <maven.compiler.target>1.8</maven.compiler.target>
                <spring-cloud.version>Dalston.SR1</spring-cloud.version>
            </properties>
         
            <dependencies>
                <dependency>
                    <groupId>junit</groupId>
                    <artifactId>junit</artifactId>
                    <version>4.11</version>
                    <scope>test</scope>
                </dependency>
         
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-zipkin</artifactId>
                </dependency>
         
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-eureka</artifactId>
                </dependency>
         
                <dependency>
                    <groupId>io.zipkin.java</groupId>
                    <artifactId>zipkin-autoconfigure-ui</artifactId>
                </dependency>
         
                <dependency>
                    <groupId>io.zipkin.java</groupId>
                    <artifactId>zipkin-server</artifactId>
                </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>
 *  `application.properties`:
    
        server.port=9411
         
        spring.application.name=dbaas-zipkin-server
        eureka.client.service-url.defaultZone=http://192.168.20.61:8761/eureka/
        eureka.instance.instance-id=${ spring.cloud.client.ipAddress}:${ server.port}
        eureka.instance.prefer-ip-address=true
         
        # zipkin 本身并不发送span
        spring.zipkin.enabled=false
 *  `ZipkinServerApplication.java`
    
        @SpringBootApplication
        @EnableEurekaClient
        @EnableZipkinServer
        public class ZipkinServerApplication { 
            public static void main(String[] args) { 
                SpringApplication.run(ZipkinServerApplication.class, args);
            }
        }

配置完毕后即可启动zipkin-server。

## Zipkin-Client ##

和`eureka-client`类似，希望发送`span`到`zipkin`的各个业务服务需要引用sleuth收集`span`信息，引用zipkin自动配置默认通过`HTTP`方式，才可以将`span`信息发送到`zipkin-server`。

*  `pom.xml`
    
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
         
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>
 *  `application.properties`:
    
        # zipkin
        # 打开zipkin discovery
        spring.zipkin.locator.discovery.enabled=true
        # 指定zipkin-server 地址
        spring.zipkin.baseUrl=http://192.168.20.62:9411/
        # 指定span采集概率
        spring.sleuth.sampler.percentage=1.0
        # 指定不采集的路径正则
        #spring.sleuth.web.skipPattern=(^cleanup.*)

所有服务配置完毕并成功启动就会自动加入zipkin链路跟踪。

## Zipkin-Ui ##

打开`zipkin-server`的web页面(192.168.20.62:9411)：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70]  
页面上的筛选和排序点点就会了，哪个Annotation Query可以点击某一个trace后再点击一个span查看有哪些元数据，然后根据这些元数据查询：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 4]  
依赖关系非常清楚：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 5]

[Dapper_ a Large-Scale Distributed Systems Tracing Infrastructure]: https://ai.google/research/pubs/pub36356.pdf
[Dapper]: http://bigbully.github.io/Dapper-translation/
[Spring Cloud Sleuth]: https://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/2.1.0.RC3/single/spring-cloud-sleuth.html
[Integrations]: https://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/2.1.0.RC3/single/spring-cloud-sleuth.html#_integrations
[Managing Spans with Annotations]: https://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/2.1.0.RC3/single/spring-cloud-sleuth.html#_managing_spans_with_annotations
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70]: /images/20220325/dbe44e7140d940a7902f2c9d98817580.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 1]: /images/20220325/27d7ab5b68294372be2a9941d3fc58ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 2]: /images/20220325/f487f44b9146465f8738457e0c947680.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 3]: /images/20220325/c9a8a7d958134480823061e36d6a383d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 4]: /images/20220325/a43226c7d5854299985fe33d2dce8b16.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 5]: /images/20220325/13f758e1d63045cfb057db7d2284aa4e.png