Spring （52）Spring Cloud Sleuth

Victor356
95 阅读3分钟

Spring Cloud Sleuth是一个分布式跟踪解决方案，它可以帮助我们追踪在微服务架构中发起的请求的路径。通过给服务间调用的请求自动添加跟踪ID和跨度ID，Spring Cloud Sleuth让我们能够轻松地识别和定位服务间调用的延时问题，了解整个分布式系统的行为和性能瓶颈。接下来，我将结合源码解析、代码演示和细节，深入了解Spring Cloud Sleuth。

核心概念

  • Trace ID：跟踪ID，标志一次请求链路的唯一标识。
  • Span ID：跨度ID，表示请求链路中的一个特定工作单元。
  • Parent Span ID：父跨度ID，用来表示上一个Span的ID。
  • Tags/Annotations：标签/注解，用于记录额外的信息，如请求的URL、状态码等。

环境准备和配置

首先，添加Spring Cloud Sleuth的依赖到你的pom.xml文件中：

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

这是最基本的依赖配置，Spring Cloud Sleuth会自动配置其余所需的组件。

整合示例

为了演示如何使用Spring Cloud Sleuth，我们将创建一个简单的微服务应用，该应用会调用另一个服务。

Service A:

@RestController
public class ServiceAController {

    private final RestTemplate restTemplate;

    public ServiceAController(RestTemplateBuilder restTemplateBuilder) {
        this.restTemplate = restTemplateBuilder.build();
    }

    @GetMapping("/call")
    public String callServiceB() {
        // 假设Service B的URL是http://localhost:8081/serviceB
        return restTemplate.getForObject("http://localhost:8081/serviceB", String.class);
    }

    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

Service B:

@RestController
public class ServiceBController {

    @GetMapping("/serviceB")
    public String serviceB() {
        return "Hello from Service B";
    }
}

在这个例子中，当调用Service A的/call端点时，它会进一步调用Service B的/serviceB端点。

Sleuth的工作原理

当请求到达Service A时，Spring Cloud Sleuth会自动生成一个Trace ID和一个Span ID。当Service A再调用Service B时，这些ID会被传递给Service B。这样，无论请求流经系统的哪些组件，我们都可以通过这些ID追踪整个请求链路。

源码解析

Spring Cloud Sleuth的核心是在请求进入和离开时创建和关闭Span。这是通过一系列的过滤器和拦截器实现的，它们自动地在请求到达时创建新的Span，和在请求完成时关闭Span。

以TraceWebServletAutoConfiguration为例，它会注册TracingFilter，这个过滤器负责为每个HTTP请求创建和关闭Span：

@Bean
public FilterRegistrationBean tracingFilter(SkipPatternProvider skipPatternProvider) {
    FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
    filterRegistrationBean.setFilter(new TracingFilter(...));
    // 其他配置省略
    return filterRegistrationBean;
}

当TracingFilter收到一个HTTP请求时，它会检查请求中是否包含Trace ID和Span ID。如果没有，它会创建它们。然后，这些ID会在处理请求的过程中通过各种手段（比如HTTP头）传递给其他服务。

小结

Spring Cloud Sleuth通过为服务间的请求自动添加跟踪ID和跨度ID，简化了分布式系统中的问题诊断过程。它与日志系统（如Logback或Log4j2）以及分布式跟踪系统（如Zipkin）的集成，使得跟踪信息的收集和分析变得更加容易。通过Sleuth，我们可以获取到服务之间调用的详细信息，如调用持续时间、调用路径等，这对于诊断延迟问题和性能瓶颈至关重要。

avatar
文章
阅读
粉丝