如何在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服務器的地址。