如何在Java应用中实现分布式追踪：使用Sleuth与Zipkin的最佳实践

wx_tangjinjinwx

于 2024-09-18 07:00:00 发布

阅读量431

点赞数 8

文章标签： java 分布式开发语言

本文链接：https://blog.csdn.net/u011269762/article/details/142034392

版权

如何在Java应用中实现分布式追踪：使用Sleuth与Zipkin的最佳实践

大家好，我是微赚淘客返利系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！在微服务架构中，分布式追踪是一项关键技术，它帮助我们跟踪请求在不同服务之间的流转，定位性能瓶颈和故障源。本文将介绍如何在Java应用中使用Sleuth与Zipkin实现分布式追踪，并提供最佳实践与示例代码。

一、Sleuth与Zipkin概述

1.1 Sleuth

Spring Cloud Sleuth是一个用于分布式系统中的追踪数据收集的库。它为每个请求生成唯一的追踪ID，并在微服务间传播这些ID，使得追踪整个请求路径变得简单。Sleuth与Zipkin集成，可以将追踪信息发送到Zipkin服务器，进行集中式的跟踪和分析。

1.2 Zipkin

Zipkin是一个分布式追踪系统，能够收集来自不同微服务的追踪数据，并提供可视化的追踪信息，帮助我们分析请求的流转过程和性能问题。Zipkin可以与Sleuth配合使用，将追踪信息展示在统一的控制台中。

二、集成Spring Cloud Sleuth

2.1 添加依赖

首先，我们需要在Spring Boot项目中添加Sleuth和Zipkin的依赖。以下是pom.xml中的依赖配置：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Cloud Sleuth -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-sleuth</artifactId>
    </dependency>

    <!-- Zipkin -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-zipkin</artifactId>
    </dependency>
</dependencies>

2.2 配置Sleuth

在application.properties或application.yml中配置Zipkin的地址，Sleuth将追踪信息发送到该地址：

# application.properties
spring.zipkin.baseUrl=http://localhost:9411/
spring.sleuth.sampler.probability=1.0

在上述配置中，spring.zipkin.baseUrl指定了Zipkin的服务地址，spring.sleuth.sampler.probability设定了采样率，1.0表示100%采样。

2.3 示例代码

以下是一个简单的Spring Boot应用，展示如何使用Sleuth进行分布式追踪：

package cn.juwatech.tracing;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class TracingApplication {
    public static void main(String[] args) {
        SpringApplication.run(TracingApplication.class, args);
    }
}

@RestController
@RequestMapping("/api")
class ApiController {
    @GetMapping("/trace")
    public String trace() {
        return "Tracing with Sleuth!";
    }
}

在这个示例中，@RestController注解的ApiController类定义了一个RESTful接口。当请求到达/api/trace时，Sleuth会自动为该请求生成追踪信息，并将其发送到Zipkin。

三、配置Zipkin服务器

3.1 启动Zipkin

Zipkin可以通过Docker快速启动：

docker run -d -p 9411:9411 openzipkin/zipkin

Zipkin默认监听9411端口。启动后，可以通过访问http://localhost:9411查看Zipkin的UI界面。

3.2 查看追踪信息

在Zipkin UI中，你可以看到所有从Sleuth传来的追踪信息，包括服务调用链、每个调用的时间分布等。这些信息对于分析请求流转过程和定位性能瓶颈非常有用。

四、在微服务架构中的应用

在微服务架构中，追踪信息的收集和分析变得更加重要。每个服务都需要集成Sleuth，并将追踪信息发送到Zipkin。这样，我们就能在Zipkin中查看完整的请求链路，了解请求如何在不同服务间流转，并监控服务之间的依赖关系。

4.1 多服务环境配置

如果你有多个微服务，可以在每个微服务中配置Sleuth，并将所有追踪信息发送到同一个Zipkin服务器。这将允许你在Zipkin UI中查看跨服务的完整请求链路。

4.2 自定义追踪信息

除了默认的追踪信息，你还可以通过Sleuth的API自定义追踪数据。例如，你可以添加自定义标签或注释，以便更好地分析请求数据。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.sleuth.Tracer;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class CustomTracingController {
    
    @Autowired
    private Tracer tracer;
    
    @GetMapping("/custom-trace")
    public String customTrace() {
        tracer.currentSpan().tag("custom-tag", "custom-value");
        return "Custom tracing with Sleuth!";
    }
}