什么是 Sleuth？

Sleuth 是一個分布式跟蹤系統(tǒng)，用于跟蹤應用程序中的請求和操作。它可以幫助我們了解應用程序的結構和性能，并定位問題的根本原因。Sleuth 可以與 Zipkin 等分布式跟蹤系統(tǒng)配合使用，從而提供更全面的應用程序跟蹤和分析功能。

Sleuth 在 Spring Boot 中提供了一個便捷的集成方式。它可以輕松地跟蹤應用程序中的請求和操作，并將跟蹤信息記錄到日志文件中。這使得我們可以更輕松地了解應用程序的結構和性能，并快速定位問題的根本原因。

Sleuth 的核心概念

在使用 Sleuth 之前，我們需要了解一些核心概念：

• Trace（跟蹤）：一個 Trace 表示一個請求或操作的完整的調用鏈，從客戶端發(fā)起請求開始，到服務端響應請求結束。
• Span（跨度）：一個 Span 表示一個請求或操作的一部分，它包含了一些有用的信息，如開始時間、結束時間、操作名稱等。
• Trace ID（跟蹤 ID）：一個 Trace ID 是一個唯一的標識符，它用于將一組 Span 關聯(lián)在一起，形成一個完整的 Trace。
• Span ID（跨度 ID）：一個 Span ID 是一個唯一的標識符，它用于標識一個 Span。

在 Sleuth 中，每個請求或操作都會生成一個 Trace，并且每個 Trace 包含多個 Span。每個 Span 包含一個唯一的 Span ID，并與一個 Trace ID 相關聯(lián)。通過 Trace ID 和 Span ID，我們可以將多個 Span 關聯(lián)在一起，形成一個完整的 Trace。

使用 Sleuth

要使用 Sleuth，我們需要將 Sleuth 依賴添加到項目中。在 Maven 項目中，可以在 pom.xml 文件中添加以下依賴：

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

在Gradle項目中，可以在 build.gradle 文件中添加以下依賴：

implementation 'org.springframework.cloud:spring-cloud-starter-sleuth'

添加依賴后，Sleuth 就會自動啟用，并開始跟蹤應用程序中的請求和操作。Sleuth 會自動為每個請求或操作生成一個 Trace，并為每個 Trace 中的每個 Span 生成一個唯一的 Span ID。

默認情況下，Sleuth 會將 Trace ID 和 Span ID 添加到日志中，以便我們可以輕松地跟蹤應用程序中的請求和操作。例如，下面是一個包含 Trace ID 和 Span ID 的日志：

2021-09-01 12:00:00.000 [my-service,0123456789abcdef,0123456789abcdef,true] TRACE [MyController] - Handling request

在上面的例子中，日志中包含了一個 Trace ID（0123456789abcdef）和一個 Span ID（0123456789abcdef），它們分別與一個名為 my-service 的服務相關聯(lián)。

自定義 Sleuth 配置

在使用 Sleuth 時，我們可以通過配置文件或編程方式進行自定義配置。以下是一些常用的自定義配置方式：

配置 Trace 和 Span 的名稱

默認情況下，Sleuth 會為每個 Trace 和Span 分別使用應用程序的名稱和隨機生成的 ID。如果需要自定義 Trace 和 Span 的名稱，可以在 application.properties（或 application.yaml）文件中添加以下配置：

spring.sleuth.sampler.probability=1.0
spring.application.name=my-custom-app-name
spring.sleuth.span-name-regex=(?<controller>MyController)

上面的配置將會將 Trace 的名稱設置為 my-custom-app-name，將所有包含 MyController 的 Span 設置為 MyController。同時，spring.sleuth.sampler.probability=1.0 確保 Sleuth 對所有請求和操作進行跟蹤。

配置 Sleuth 的 Sampler

在實際的生產(chǎn)環(huán)境中，我們可能需要對請求和操作進行采樣，以避免 Sleuth 產(chǎn)生過多的跟蹤數(shù)據(jù)。在 Sleuth 中，采樣是通過 Sampler 實現(xiàn)的。默認情況下，Sleuth 使用一個隨機采樣器，它對 10% 的請求進行采樣。

如果需要自定義采樣器，可以在配置文件中添加以下配置：

spring.sleuth.sampler.type=RATE_LIMITED
spring.sleuth.sampler.rate=0.5

上面的配置將會將采樣器設置為 RATE_LIMITED，它會根據(jù)請求速率限制采樣率。具體而言，它將對 50% 的請求進行采樣。

使用 MDC（Mapped Diagnostic Context）

在實際的生產(chǎn)環(huán)境中，我們可能需要將 Trace 和 Span 的信息傳遞給 Logback 或 Log4j2 等日志框架。為了實現(xiàn)這一點，Sleuth 提供了一個 MDC（Mapped Diagnostic Context）實現(xiàn)，它可以將 Trace 和 Span 的信息添加到日志中。

要使用 MDC，我們需要在 application.properties（或 application.yaml）文件中添加以下配置：

logging.pattern.level=%X{traceId} %X{spanId} %5p [${spring.zipkin.service.name:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}] [%t] %logger{5} - %msg%n

上面的配置將在日志模式中添加 Trace 和 Span 的信息。這樣，我們就可以輕松地跟蹤應用程序中的請求和操作，并將跟蹤信息添加到日志中。

總結

本文介紹了 Spring Boot 中的 Sleuth，它是一個分布式跟蹤系統(tǒng)，用于跟蹤應用程序中的請求和操作。我們了解了 Sleuth 的核心概念，包括 Trace、Span、Trace ID 和 Span ID，并探討了如何使用 Sleuth。

在實際的生產(chǎn)環(huán)境中，我們可以通過自定義配置來使用 Sleuth。例如，我們可以配置 Trace 和 Span 的名稱、采樣器類型和速率，以及使用 MDC 將 Trace 和 Span 的信息添加到日志中。這些功能可以幫助我們更輕松地了解應用程序的結構和性能，并快速定位問題的根本原因。

到此這篇關于深入探究SpringBoot中的Sleuth用法的文章就介紹到這了,更多相關SpringBoot Sleuth內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論