微服务链路追踪Spring Cloud Sleuth整合Zipkin解析

2023年5月25日下午6:28 • 人工智能概览

让我们来详细讲解一下微服务链路追踪Spring Cloud Sleuth整合Zipkin解析的完整攻略。

1. 简介

在微服务架构中，单个请求可能需要经过多个服务的处理，因此如何快速定位服务中的问题变得尤为重要。这时候，我们就需要用到微服务链路追踪技术，它可以帮助我们快速地找到问题服务，并定位问题所在。

Spring Cloud Sleuth是针对微服务架构下的链路追踪提供的一种解决方案。它基于 OpenZipkin，通过为服务分配统一的 TraceId 和 SpanId 来跟踪整个调用链路，从而记录整个请求的响应时间、错误率等关键指标数据。

2. 整合步骤

下面，我们将介绍如何在Spring Cloud应用中整合Spring Cloud Sleuth和Zipkin。

2.1 添加依赖

首先，需要在pom.xml文件中添加如下依赖：

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

<dependency>
    <groupId>io.zipkin.java</groupId>
    <artifactId>zipkin-server</artifactId>
    <version>2.23.4</version>
</dependency>

<dependency>
    <groupId>io.zipkin.java</groupId>
    <artifactId>zipkin-autoconfigure-ui</artifactId>
    <version>2.23.4</version>
</dependency>

其中，spring-cloud-starter-sleuth是Spring Cloud Sleuth和Brave的Starter，zipkin-server是Zipkin Server，zipkin-autoconfigure-ui是 Zipkin 的 UI。

2.2 配置文件

接下来，需要在application.yaml文件中添加如下配置：

spring:
  application:
    name: bootstrap   # 当前应用名称
  sleuth:
    sampler:
      probability: 1.0
  config:
    import: "optional:configserver:"   # 从配置中心读取配置
zipkin:
  base-url: http://localhost:9411    # Zipkin Server的地址

这里，spring.application.name是应用名称，sleuth.sampler.probability是采样率，zipkin.base-url是 Zipkin Server 的地址。

2.3 启动Zipkin Server

现在，可以启动 Zipkin Server 了，启动命令如下：

java -jar zipkin-server-2.23.4-exec.jar

启动后，可以在浏览器中输入 http://localhost:9411/ 访问 Zipkin 的 UI 界面。

2.4 集成Sleuth

现在，可以在 Spring Cloud 应用中集成 Sleuth 了。接下来，我们以 Spring Boot 为例，介绍如何集成 Sleuth。

2.4.1 集成RestTemplate

在 Spring Boot 中，可以通过 RestTemplate 来发送 HTTP 请求。为了使 Sleuth 能够跟踪 RestTemplate 请求，需要使用 Sleuth 提供的 RestTemplate Bean，添加如下代码：

@Bean
@LoadBalanced
public RestTemplate restTemplate(RestTemplateBuilder builder) {
    return builder.build();
}

这里，使用了 @LoadBalanced 注解来开启负载均衡功能。

2.4.2 集成Feign

类似的，在 Spring Boot 中，还可以通过 Feign 来实现服务调用。为了使 Sleuth 能够跟踪 Feign 调用，需要为 Feign 客户端设置 Sleuth 的日志格式，添加如下代码：

@Configuration
public class FeignConfig {
    @Bean
    public feign.Logger.Level feignLoggerLevel() {
        return feign.Logger.Level.FULL;
    }
}

2.5 示例说明

接下来，我们通过两个示例来说明 Spring Cloud Sleuth 整合 Zipkin 的具体实现。

示例1：RestTemplate请求

前提条件：有两个服务，分别是 service-a 和 service-b，其中 service-a 调用了 service-b。

首先，我们需要在 service-a 中添加一个调用 service-b 的接口，代码如下：

@RestController
public class ServiceAController {
    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/call")
    public String call() {
        return restTemplate.getForObject("http://service-b/hello", String.class);
    }
}

这里，我们使用了 Sleuth 提供的 RestTemplate Bean 来发送 HTTP 请求。

然后，我们在 service-b 中添加一个 /hello 接口，代码如下：

@RestController
public class ServiceBController {
    @GetMapping("/hello")
    public String hello() {
        return "hello, world!";
    }
}

最后，启动服务并进行测试。可以在 Zipkin 的 UI 中看到服务调用的链路关系和相应时间等信息。

示例2：Feign调用

前提条件：有两个服务，分别是 service-a 和 service-b，其中 service-a 调用了 service-b。

首先，需要在 service-a 中添加一个调用 service-b 的 Feign 客户端，代码如下：

@FeignClient("service-b")
public interface ServiceBFeignClient {
    @GetMapping("/hello")
    String hello();
}

Feign 客户端可以通过接口的方式来定义，这里使用了 @FeignClient 注解来标识。

然后，我们在 service-a 中添加一个调用 Feign 客户端的接口，代码如下：

@RestController
public class ServiceAController {
    @Autowired
    private ServiceBFeignClient serviceBFeignClient;

    @GetMapping("/call")
    public String call() {
        return serviceBFeignClient.hello();
    }
}

最后，启动服务并进行测试。可以在 Zipkin 的 UI 中看到服务调用的链路关系和相应时间等信息。