Spring Cloud Sleuth 分布式链路请求跟踪的配置与实现

一、什么是 Sleuth 分布式链路请求跟踪

官网：https://github.com/spring-cloud/spring-cloud-sleuth

在微服务框架中，一个由客户端发起的请求在后端系统中会经过多个不同的的服务节点调用来协同产生最后的请求结果，每一个请求都会形成一条复杂的分布式服务调用链路，链路中的任何一环出现高延时或错误都会引起整个请求最后的失败。

而 Spring Cloud Sleuth 就为此问题提供了一套完整的服务跟踪的解决方案，同时并兼容支持 zipkin。

简单的来说就是 Sleuth 整合了 zipkin。

何为 zipkin

可简单的理解为：微服务之间的服务调用所发送的跟踪数据由 Sleuth 所收集，通过 zipkin 将这些数据呈现出来。
​

二、zipkin server 的安装与搭建

Spring Cloud 从 F 版本开始就不再需要自己构建 Zipkin Server了，只用本地下载相应 jar 包然后调用 jar 包即可。

下载地址：https://developer.aliyun.com/mvn/search，在 阿里云仓库中选择仓库为关键字为 zipkin-server 进行搜索。

然后点击你所需要的 jar 包版本，然后点击下载链接即可进行下载。

如何运行 zipkin server呢？

首先找到 jar 包所下载的文件目录，然后在命令窗口运行以下 jar 包命令：

java -jar zipkin-server-2.23.5-exec.jar

然后在浏览器地址栏中输入地址：http://localhost:9411/zipkin/即可查看 zipkin dashboard 面板页面。

zipkin 完整调用链路

如图表示一请求链路，一条链路通过 Trace Id 唯一标识，Span 标识发起的请求信息，各 span 通过 parent id 关联起来

可以简化为：

整个链路的依赖关系如下：

相关名词解释：

Trace：类似于树结构的 Span 集合，表示一条调用链路，存在唯一标识即一个 Trace Id 只能标识一条服务调用链路。

Span：表示调用链路的来源，通俗的可以理解为 span 就是一次请求信息。

三、Sleuth 链路监控展现的实现

1、首先配置编写服务提供者

（1）在 pom.xml 中添加如下依赖

<!--包含了sleuth+zipkin-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-zipkin</artifactId>
</dependency>

（2）在 application.yml 配置文件中添加如下配置

spring:
  application:
    name: cloud-provider-payment
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      #采样率值介于 0 到 1 之间，1 则表示全部采集
      probability: 1

添加的位置如图所示：

（3）编写 controller （这里为了简单的演示就只编写控制器）

// =======> zipkin
@GetMapping("/payment/zipkin")
public String paymentZipkin() {
    return "hi ,i'am paymentzipkin server fall back，welcome to here，O(∩_∩)O哈哈~";
}

2、配置编写服务消费者

（1）在 pom.xml 中添加如下依赖

<!--包含了sleuth+zipkin-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-zipkin</artifactId>
</dependency>

（2）在 application.yml 中添加如下配置

spring:
  application: 
    name: cloud-consumer-order
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      #采样率值介于 0 到 1 之间，1 则表示全部采集
      probability: 1

（3）编写暴露的接口

/**
 * @Author Herz
 * @Date 2021/12/30 17:08
 */
@Component
@FeignClient(value = "CLOUD-PROVIDER-PAYMENT")
public interface PaymentFeignService {

    @GetMapping("/payment/zipkin")
    String paymentZipkin();
}

（4）编写 controller

/**
 * @Author Herz
 * @Date 2021/12/30 17:14
 */
@RestController
@Slf4j
public class OrderController {

    @Autowired
    private PaymentFeignService paymentFeignService;
    
    // =======> zipkin
    @GetMapping("/consumer/payment/zipkin")
    public String paymentZipkin() {
        return paymentFeignService.paymentZipkin();
    }
}

测试：启动服务提供者与服务消费者以及注册中心，并启动 zipkin-server

在地址栏中输入地址发送请求：http://localhost/consumer/payment/zipkin（我这里刷新了四次，总共发了五次请求）

输入地址 http://localhost:9411/zipkin/，然后选择查询条件 serverName，即可查看微服务之间的调用以及依赖关系