当前位置：首页 > news >正文

Spring Cloud Sleuth 链路追踪

news 来源：原创 2025/5/13 5:37:32

Spring Cloud Sleuth 是一个分布式追踪解决方案，帮助你在基于 Spring 的系统中追踪请求如何在多个微服务之间流转。它能提供关于请求流转的关联信息，有助于调试、监控以及理解微服务之间的交互。从而更容易识别瓶颈、延迟问题和故障。

Spring Cloud Sleuth 的最后一个小版本是 3.1，它不适用于 Spring Boot 3.x 及更高版本。其核心功能已迁移到 Micrometer Tracing 项目。这里还是以spring boot 2版本演示功能。

添加依赖

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

定义应用名称：spring.application.name = sleuthTest

controller定义

@RestController
@Slf4j
public class SleuthTestController {@RequestMapping("/sleuth/test")public String test(){log.info("hello,sleuth");return "ok";}
}

然后启动springboot访问定义的接口，最后日志会输出：

2025-05-12 16:11:57.949 INFO [sleuthTest,d5e3526e52257a4b,d5e3526e52257a4b] 11192 — [io-18820-exec-4] com.cpx.controller.SleuthTestController : hello,sleuth
2025-05-12 16:11:57.950 INFO [sleuthTest,d5e3526e52257a4b,d5e3526e52257a4b] 11192 — [io-18820-exec-4] com.cpx.controller.SleuthTestController : end

这里看到sleuth往日志中加了一些东西，方括号中间部分。

[application name,traceId,spanId]

traceId(链路)：一条链路代表一个请求在分布式系统中的完整流程。它有一个在处理该请求的所有服务中保持不变的唯一 ID。

spanId(跨度)：一个跨度代表链路中的一个具体操作。处理请求所涉及的每个服务或组件都会创建一个或多个跨度。跨度有自己的唯一 ID

手动开启新span

正常情况下在同一个服务中，controller调用本服务内的service这个会是同一个span。但是可以通过Tracer来手动开启一个新span。

public class SleuthService {@Autowiredprivate Tracer tracer;public void test(){Span span = tracer.nextSpan().name("service").start();try(Tracer.SpanInScope ws = tracer.withSpan(span)){log.info("service do sth");}finally {span.end();}}
}

这里service.test方法会和controller的traceId相同，spanId不同。

跨服调用

首先还是假设有一个system服务，这个seluth服务调用system服务的一个接口。这两个模块都要依赖starter-naocos-discovery和starter-seluth。seluth模块还要依赖openfeign模块。依赖就不贴了，前面的文章都有提到过。这里发没发现一个问题，在开发微服务项目时候很多都需要依赖共同的一些基础包，这个时候其实可以抽出来一个common模块，用来定义公共依赖和配置，然后每个服务依赖这个模块，这样就不用在每个服务里都写一遍共同依赖了。

回到我们跨服务调用场景里来：

先看被调用服务system：

添加seluth依赖

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

nacos注册部分就不写了，定义一个接口

@RestController
public class TestController {@RequestMapping("/sys/params")public String params(){log.info("system params");return "params";}
}

这里打印一行日志就是用来观察seluth输出信息变化的

seluth服务：

添加nacos依赖，openfeign依赖用来调用system服务上面定义的接口。

启动类上添加@EnableFeignClients开启feign，然后定义一个feignclient

@FeignClient(value = "system",qualifiers = "systemClient")
public interface SystemClient {@RequestMapping("/sys/params")public String getSysParams();
}

然后在controller里调用systemClient

@Resource
private SystemClient systemClient;@RequestMapping("/sleuth/feign")
public String feign(){log.info("start");systemClient.getSysParams();log.info("end");return "ok";
}

调用接口/sleuth/feign然后观察日志：

sleuth服务：

2025-05-12 16:19:03.272 INFO [sleuthTest,dbfab2d909e6adc5,dbfab2d909e6adc5] 11192 — [o-18820-exec-10] com.cpx.controller.SleuthTestController : start
2025-05-12 16:19:03.281 INFO [sleuthTest,dbfab2d909e6adc5,dbfab2d909e6adc5] 11192 — [o-18820-exec-10] com.cpx.controller.SleuthTestController : end

system服务：

2025-05-12 16:19:03.280 INFO [system,dbfab2d909e6adc5,315a41e1974cae6f] 13212 — [io-18082-exec-4] com.cpx.TestController : system params

这里发现sleuth服务调用system服务，traceId相同，spanId变了。这样如果所有日志最后通过日志收集到一块后，就可以很容易根据traceId进行追踪调用链路。这里在调用system服务的时候，是由sleuth将traceId和spanId通过http header传递给system的。

Sleuth 自动检测并记录常见的 Spring 组件和库的操作，例如 Spring MVC、RestTemplate、Spring WebFlux、Feign 客户端、Spring Cloud Gateway 和消息中间件。无需编写任何代码即可获得基本的追踪信息。