如何在spring boot项目中集成sleuth?首先,在pom.xml中添加sleuth依赖:spring-cloud-starter-sleuth;其次,如需对接zipkin,添加spring-cloud-sleuth-zipkin依赖;然后,在配置文件中设置zipkin服务器地址和应用名称。sleuth会自动生成traceid和spanid,并通过http header传递。sleuth的核心概念包括trace id(请求链路唯一标识)、span id(调用链中的独立单元)、parent id(父span的id)和annotations(记录时间点如cs、sr等)。如何自定义追踪行为?可使用@newspan创建新span,或@spanname修改span名称,也可通过tracer对象手动添加tag和log。如何选择后端?zipkin适合小型项目,jaeger支持采样与拓扑分析,skywalking提供强大插件生态与性能诊断能力。高并发下可通过采样(设置spring.sleuth.sampler.probability)、异步上报、优化存储、高效探针减少性能影响。非spring cloud环境下可引入brave依赖,手动创建tracer对象并配置服务名、采样器等实现追踪。
链路追踪,简单来说,就是在分布式系统中跟踪请求的完整调用链。Sleuth是Spring Cloud生态中实现链路追踪的利器,它能帮你轻松地监控和诊断微服务架构中的性能瓶颈。
直接使用Spring Cloud Sleuth和Zipkin,或者结合更强大的工具如Jaeger或Skywalking。
如何在spring boot项目中集成Sleuth?
首先,在你的pom.xml文件中添加Sleuth的依赖:
立即学习“Java免费学习笔记(深入)”;
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-sleuth</artifactId> </dependency>
其次,如果需要将追踪数据发送到Zipkin,还需要添加Zipkin客户端的依赖:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-sleuth-zipkin</artifactId> </dependency>
然后,在application.properties或application.yml中配置Zipkin服务器的地址:
spring.zipkin.baseUrl=http://localhost:9411/ spring.application.name=your-service-name # 建议设置,用于标识服务
完成以上步骤,Sleuth就能自动为你生成traceId和spanId,并通过HTTP Header在服务间传递。
Sleuth的核心概念是什么?
Sleuth涉及几个关键概念,理解它们对掌握链路追踪至关重要:
- Trace ID: 整个请求链路的唯一标识。一个请求从进入系统到最终完成,所有相关的span都共享同一个trace ID。
- Span ID: 代表调用链中的一个独立单元,比如一个HTTP请求、一个数据库查询。每个span都有一个span ID,用于标识自身的执行过程。
- Parent ID: 表示当前span的父span的ID。通过parent ID,可以将span组织成树状结构,还原请求的完整调用链。
- Annotations: 记录span事件的关键时间点,例如cs (Client Send), sr (Server Receive), ss (Server Send), cr (Client Receive)。这些时间点能帮助你分析请求的耗时。
想象一下,你发起一个请求,这个请求会经过多个微服务处理。Trace ID就像一个身份证,贯穿整个流程,而每个微服务处理请求的过程就是一个Span,记录着处理的开始和结束时间。
如何自定义Sleuth的追踪行为?
Sleuth默认会追踪所有进出Spring管理的bean的方法调用,以及通过RestTemplate或WebClient发起的HTTP请求。但有时你需要更细粒度的控制,比如忽略某些方法的追踪,或者添加自定义的tag。
你可以使用@NewSpan注解来创建一个新的span:
import brave.Span; import brave.Tracer; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class MyService { @Autowired private Tracer tracer; public void doSomething() { Span newSpan = tracer.nextSpan().name("custom-span").start(); try { // 你的业务逻辑 Thread.sleep(100); } finally { newSpan.finish(); } } }
或者,使用@SpanName注解来修改现有span的名称。
import org.springframework.cloud.sleuth.annotation.SpanName; import org.springframework.stereotype.Service; @Service public class MyService { @SpanName("myCustomName") public void doSomething() { // 你的业务逻辑 } }
此外,你还可以通过Tracer对象来手动创建和管理span,添加自定义的tag和log:
import brave.Tracer; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class MyService { @Autowired private Tracer tracer; public void doSomething() { tracer.currentSpan().tag("my-custom-tag", "some-value"); tracer.currentSpan().annotate("doing something important"); // 你的业务逻辑 } }
如何选择合适的链路追踪后端?Zipkin、Jaeger、Skywalking对比
Sleuth本身只负责生成和传递追踪数据,你需要选择一个链路追踪后端来收集、存储和展示这些数据。常见的选择有Zipkin、Jaeger和Skywalking。
- Zipkin: 是最早的开源链路追踪系统之一,简单易用,适合小型项目或快速原型验证。但功能相对简单,缺乏高级特性,例如拓扑分析和告警。
- Jaeger: 由Uber开源,功能更强大,支持采样、分布式上下文传递、拓扑分析、告警等高级特性。Jaeger的ui也比Zipkin更友好。
- Skywalking: 是国产的开源链路追踪系统,针对云原生架构进行了优化,支持多种协议和语言,提供强大的性能分析和诊断能力。Skywalking的优势在于其强大的自动化探针和丰富的插件生态。
选择哪个后端取决于你的具体需求和技术栈。如果你的项目规模较小,或者只需要基本的链路追踪功能,Zipkin是一个不错的选择。如果你的项目规模较大,需要更高级的特性,Jaeger或Skywalking可能更适合你。
如何解决Sleuth在高并发下的性能问题?
在高并发场景下,Sleuth可能会带来一定的性能开销。为了解决这个问题,可以考虑以下几个方面:
- 采样: Sleuth默认会追踪所有的请求,但在高并发场景下,可以开启采样,只追踪一部分请求。可以通过spring.sleuth.sampler.probability属性来设置采样率。例如,设置为0.1表示只追踪10%的请求。
- 异步上报: Sleuth默认会同步地将追踪数据发送到Zipkin等后端,这会阻塞请求处理线程。可以配置Sleuth使用异步上报,将追踪数据放入队列,由单独的线程异步发送。
- 优化后端存储: 链路追踪数据量通常很大,需要选择一个高性能的存储后端。例如,可以使用elasticsearch或Cassandra来存储Zipkin的数据。
- 使用更高效的探针: 一些链路追踪系统提供了更高效的探针,例如基于eBPF的探针,可以减少对应用程序的性能影响。
如何在没有Spring Cloud的环境中使用Sleuth?
虽然Sleuth是Spring Cloud生态的一部分,但也可以在非Spring Cloud环境中使用。你需要手动创建Tracer对象,并使用它来创建和管理span。
首先,添加Sleuth的核心依赖:
<dependency> <groupId>io.zipkin.brave</groupId> <artifactId>brave</artifactId> <version>5.x.x</version> </dependency>
然后,创建一个Tracer对象:
import brave.Tracing; import brave.sampler.Sampler; public class MyClass { private final Tracing tracing = Tracing.newBuilder() .serviceName("my-service") .sampler(Sampler.ALWAYS_SAMPLE) // 或者使用Sampler.NEVER_SAMPLE .build(); private final brave.Tracer tracer = tracing.tracer(); public void doSomething() { brave.Span span = tracer.nextSpan().name("my-operation").start(); try { // 你的业务逻辑 } finally { span.finish(); } } }
注意,你需要手动配置Tracing对象,包括服务名称、采样器等。如果你想将追踪数据发送到Zipkin,还需要添加Zipkin reporter的依赖,并配置Zipkin服务器的地址。