Spring Cloud Sleuth结合Zipkin实现链路追踪

- 日理万妓 2023-01-13 08:51 173阅读 0赞

# 1.概述 #

## 1.1 技术背景 ##

在微服务架构中，随着业务发展，系统拆分导致系统调用链路愈发复杂，一个看似简单的前端请求可能最终需要调用很多次后端服务才能完成，那么当整个请求出现问题时，我们很难得知到底是哪个服务出了问题导致的，这时就需要解决一个问题，即如何快速定位服务故障点，分布式系统调用链追踪技术就此诞生了。

## 1.2 Zipkin ##

*  Zipkin是一个由Twitter公司提供并开放源代码分布式的跟踪系统， 它主要用于收集服务的时间数据；
 *  每个服务会向Zipkin定时汇报数据；
 *  Zipkin提供ZipkinUI生成依赖关系图，展示多少跟踪请求经过了哪些服务，可非常方便地监测系统中存在的瓶颈；
 *  Zipkin提供了可插拔数据存储方式：In-Memory、MySQL、Cassandra以及Elastic search。

## 1.3 Spring Cloud Sleuth ##

*  为“各个服务间的调用”提供链路追踪；
 *  收集每个采样请求的耗时，并对于调用比较频繁的服务，可以针对这些服务实施一些优化措施。

## 1.4 二者关系 ##

Sleuth将采集的信息数据发送到Zipkin，利用Zipkin的存储来存储信息，以及利用ZipkinUI来展示数据。

# 2.教程 #

延续上一篇：[Sentinel：5.Sentinel的高级使用（二）降级规则持久化][Sentinel_5.Sentinel]，在其基础上，本篇主要演示“结合Sleuth和Zipkin实现链路追踪”。

## 2.1 在主pom.xml中添加依赖 ##

pom.xml

<dependency>
        <groupId>org.springframework.cloud</groupId> 
        <artifactId>spring-cloud-starter-sleuth</artifactId>
        <version>2.1.1.RELEASE</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-sleuth-zipkin</artifactId>
        <version>2.1.1.RELEASE</version>
    </dependency>

## 2.2 修改nacos-sample-consumer项目中的bootstrap.yml ##

nacos-sample-provider项目中的bootstrap.yml已经在[Sentinel：4.Sentinel的高级使用（一）流控规则持久化][Sentinel_4.Sentinel]中修改过了，这里为了演示链路追踪，nacos-sample-consumer服务调用nacos-sample-provider服务的接口，顺便把nacos-sample-consumer的bootstrap.yml也修改了。

bootstrap.yml

# nacos配置中心信息参数
    nacos:
      instance:
        hostname: localhost
        port: 8848
    
    spring:
      cloud:
        nacos:
          config:
            # 配置中心地址
            server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
            # 配置文件扩展名（目前只支持 properties 和 yml 类型）
            file-extension: yml
            # 配置文件名前缀（默认为 spring.application.name 的值，也可以自己手动设置）
            prefix: nacos-sample-consumer
      profiles:
        # 当 spring.profile.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}
        active: dev
        # 当前设置对应的DataID是：nacos-sample-consumer-dev.yml
        
    # 注释掉 application.name ，在Nacos配置中心里的nacos-sample-provider.yml中配置就好了
    # application:
    # # 服务名，对应service-id（在这里配置的话，项目中的bootstrap.yml里的就可以删除了）
    # name: nacos-sample-provider

## 2.3 在Nacos配置中心，修改nacos-sample-provider-dev.yml和nacos-sample-consumer-dev.yml ##

nacos-sample-provider-dev.yml

# nacos配置中心信息参数
    nacos:
      instance:
        hostname: localhost
        port: 8848
    
    # sentinel信息参数
    sentinel:
      instance:
        hostname: localhost
        port: 8849
    
    # zipkin配置中心信息参数
    zipkin:
      instance:
        hostname: localhost
        port: 9411
    
    spring:
      application:
        # 服务名，对应service-id
        name: nacos-sample-provider
      cloud:
        nacos:
          discovery:
            # 服务注册中心地址
            server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
        sentinel:
          transport:
            # sentinel控制台地址
            dashboard: ${ sentinel.instance.hostname}:${ sentinel.instance.port}
          datasource:
            # 流控规则数据源
            flow:
              nacos:
                server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
                data-id: ${ spring.application.name}-sentinel-flow
                group-id: DEFAULT_GROUP
                data-type: json
                # 格式要填写flow，对应流控规则
                rule-type: flow
            # 降级规则数据源
            degrade:
              nacos:
                server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
                data-id: ${ spring.application.name}-sentinel-degrade
                group-id: DEFAULT_GROUP
                data-type: json
                # 格式要填写degrade，对应降级规则
                rule-type: degrade
      sleuth:
        sampler:
          # 采样率
          probability: 1
      zipkin:
        sender:
          type: web
        base-url: http://${ zipkin.instance.hostname}:${ zipkin.instance.port}/
        service:
          name: nacos-sample-provider
    
    # 该服务启动后使用的端口
    server:
      port: 8001
      
    testValue: welcome!!!

nacos-sample-consumer-dev.yml

# nacos配置中心信息参数
    nacos:
      instance:
        hostname: localhost
        port: 8848
    
    # sentinel信息参数
    sentinel:
      instance:
        hostname: localhost
        port: 8849
    # zipkin配置中心信息参数
    zipkin:
      instance:
        hostname: localhost
        port: 9411
    
    spring:
      application:
        # 服务名，对应service-id
        name: nacos-sample-consumer
      cloud:
        nacos:
          discovery:
            # 服务注册中心地址
            server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
        sentinel:
          transport:
            # sentinel控制台地址
            dashboard: ${ sentinel.instance.hostname}:${ sentinel.instance.port}
          datasource:
            # 流控规则数据源
            flow:
              nacos:
                server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
                data-id: ${ spring.application.name}-sentinel-flow
                group-id: DEFAULT_GROUP
                data-type: json
                # 格式要填写flow，对应流控规则
                rule-type: flow
            # 降级规则数据源
            degrade:
              nacos:
                server-addr: ${ nacos.instance.hostname}:${ nacos.instance.port}
                data-id: ${ spring.application.name}-sentinel-degrade
                group-id: DEFAULT_GROUP
                data-type: json
                # 格式要填写degrade，对应降级规则
                rule-type: degrade
      sleuth:
        sampler:
          # 采样率
          probability: 1
      zipkin:
        sender:
          type: web
        base-url: http://${ zipkin.instance.hostname}:${ zipkin.instance.port}/
        service:
          name: nacos-sample-consumer
    
    # 该服务启动后使用的端口
    server:
      port: 8002
      
    testValue: welcome!!!

## 2.4 下载Zipkin Server，并启动服务 ##

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

## 2.5 查看链路追踪 ##

1.  Zipkin服务启动之后，可以通过[http://localhost:9411/][http_localhost_9411]访问ZipkinUI，如下图所示：

![image][]

1.  访问[http://localhost:8002/openfeign/hi?name=test][http_localhost_8002_openfeign_hi_name_test]，完成一次nacos-sample-consumer对nacos-sample-provider接口的调用，然后在ZipinUI查看调用关系

![image][image 1]

![image][image 2]

![image][image 3]

# 3.小练习 #

读者可以把nacos-sampli-consumer服务的另一个接口也调用一下，然后再看看链路追踪。

--------------------

### 本文示例源码： ###

[GitHub：WangYe8613/scanacos][GitHub_WangYe8613_scanacos]

\[commit id：8edafdf579c8c0693621b93834afe3dc748fb236\]

[Sentinel_5.Sentinel]: https://blog.csdn.net/w_y_x_y/article/details/115758915
[Sentinel_4.Sentinel]: https://blog.csdn.net/w_y_x_y/article/details/115735785
[http_localhost_9411]: http://localhost:9411/
[image]: /images/20221022/4c56a1bb62fb4ed08c3aa274efaa0151.png
[http_localhost_8002_openfeign_hi_name_test]: http://localhost:8002/openfeign/hi?name=test
[image 1]: /images/20221022/e6de8c71275b447da95f143cdc7357f6.png
[image 2]: /images/20221022/e04829654a354aaf8cf73da6c12632b8.png
[image 3]: /images/20221022/6996fcbadd68410bb9a61d1c1d147f1d.png
[GitHub_WangYe8613_scanacos]: https://github.com/WangYe8613/scanacos.git