• 1 Spring Boot 3 既 micrometer tracing
• 2 定義
  • 2.1 Trace ID
  • 2.2 Span ID
• 3 動手寫
  • 3.1 Maven dependencies
  • 3.2 寫 Java code
    • 3.2.1 Spring RestTemplate
    • 3.2.2 Spring Webflux WebClient
    • 3.2.3 Spring 6.1 RestClient
    • 3.2.4 Spring Cloud OpenFeign
  • 3.3 Logback 配置
    • 3.3.1 自定義 encoder pattern
    • 3.3.2 Logstash Logback Encoder
• 4 測試
  • 4.1 本地測試
  • 4.2 測試發送 logs 去 ELK
• 5 參考資料

!!!! IMPORTANT !!!!

Spring Cloud Sleuth’s last minor version is 3.1. You can check the 3.1.x branch for the latest commits. Spring Cloud Sleuth will not work with Spring Boot 3.x onward. The last major version of Spring Boot that Sleuth will support is 2.x.

The core of this project got moved to Micrometer Tracing project and the instrumentations will be moved to Micrometer and all respective projects (no longer all instrumentations will be done in a single repository.

You can check the Micrometer Tracing migration guide to learn how to migrate from Spring Cloud Sleuth to Micrometer Tracing.

1<parent>
2	<groupId>org.springframework.boot</groupId>
3	<artifactId>spring-boot-starter-parent</artifactId>
4	<version>3.2.3</version>
5</parent>
6
7<dependency>
8	<groupId>io.micrometer</groupId>
9	<artifactId>micrometer-registry-prometheus</artifactId>
10</dependency>
11<dependency>
12	<groupId>io.micrometer</groupId>
13	<artifactId>micrometer-tracing-bridge-brave</artifactId>
14</dependency>
15
16<dependency>
17	<groupId>net.logstash.logback</groupId>
18	<artifactId>logstash-logback-encoder</artifactId>
19	<version>7.2</version>
20</dependency>

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-webflux</artifactId>
</dependency>

1<dependency>
2	<groupId>org.springframework.cloud</groupId>
3	<artifactId>spring-cloud-starter-openfeign</artifactId>
4</dependency>
5<dependency>
6	<groupId>io.github.openfeign</groupId>
7	<artifactId>feign-micrometer</artifactId>
8</dependency>

1@Configuration
2public class RestTemplateConfig {
3
4    @Bean
5    RestTemplate restTemplate(RestTemplateBuilder builder) {
6
7        final RestTemplate restTemplate = builder
8            .setConnectTimeout(Duration.ofSeconds(10))
9            .basicAuthentication("username", "password")
10            .defaultHeader("header1", "header1-value")
11            .defaultHeader("header2", "header2-value")
12            .build();
13
14        // 如果加入左 jackson-dataformat-xml
15        // 令 RestTemplate 唔好喺 Accept request header 度加入 application/xml 或相關既 values
16        restTemplate.getMessageConverters()
17            .removeIf(e -> e.getClass()==MappingJackson2XmlHttpMessageConverter.class);
18
19        return restTemplate;
20    }
21}

1@Configuration
2public class WebClientConfig {
3
4    @Bean
5    WebClient webClient(WebClient.Builder builder) {
6
7        final HttpClient httpClient = HttpClient.newBuilder()
8            .version(Version.HTTP_1_1)
9            .connectTimeout(Duration.ofSeconds(10))
10            .build();
11
12        final WebClient client = builder
13                .clientConnector(new JdkClientHttpConnector(httpClient))
14                .defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
15                .defaultHeader("header1", "header1-value")
16                .defaultHeader("header2", "header2-value")
17                .build();
18
19        return client;
20    }
21}

1@Configuration
2public class RestClientConfig {
3
4    @Bean
5    RestClient restClient(RestClient.Builder builder) {
6
7        final RestClient client = builder
8                .defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
9                .defaultHeader("header1", "header1-value")
10                .defaultHeader("header2", "header2-value")
11                .build();
12
13        return client;
14    }
15}

• org.springframework.cloud:spring-cloud-dependencies
  • org.springframework.cloud:spring-cloud-openfeign-dependencies
    • io.github.openfeign:feign-bom

• Host name，可以直接用 ${HOSTNAME:-} 或者 ${hostname:-}。
• Spring application name，可以加入以下既配置，之後就可以用 ${app_name:-}：

  • <!-- 喺 configuration 裡面 -->
    <springProperty scope="context" name="app_name" source="spring.application.name" />

• %X{traceId:-}
• %X{spanId:-}

<!-- 喺 appender 裡面 -->
<encoder>
	<pattern>[${hostname:-} ${app_name:-}] [%X{traceId:-} %X{spanId:-}] %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} (%file:%line\) - %msg%n</pattern>
</encoder>

• 呢度既 :- 係用黎分隔 key、value 既字符，佢既前面係 MDC key，後面係 value。
  • 佢同 Spring 既 : 一樣意思，只不過係 Logback 揀左用 :-。
  • %X{key:-} 既意思係如果 key 呢個 MDC key 未有 data 既話就會出 empty string（唔好誤以為會出 -）。
  • %X{key:-foo} 既意思係如果 key 呢個 MDC key 未有 data 既話就會出 foo。

1<!-- 喺 appender 裡面 -->
2<encoder class="net.logstash.logback.encoder.LogstashEncoder">
3	<includeContext>false</includeContext>
4	<includeMdcKeyName>traceId</includeMdcKeyName>
5	<includeMdcKeyName>spanId</includeMdcKeyName>
6	<customFields>{ "host": "${hostname:-}", "app_name": "${app_name:-}" }</customFields>
7</encoder>

1. 我地需要 set up 至少兩個 Spring Boot microservices。
2. 全部 microservices 都要 expose 至少一個 HTTP REST endpoints。
3. 除左最後一個只會被 call 但唔會 initiate call 既 microservice，我地要為所有作為 upstream 既其他 microservices 寫 HTTP call 既 code。
   • HTTP REST call flow：Service A ➜ Service B ➜ Service C 等等。
   • HTTP REST call 既 implementation 可以係 RestTemplate、WebClient、RestClient 或者 OpenFeign。
4. 用 cURL call Service A 既 HTTP REST endpoint。
5. 檢查所有 microservices 既 console logs。
   • 應該會見到只有一個 32 個位長度 alphanumeric 既 trace ID。
   • 應該會見到每個 microservice 都有啲唔同既 16 個位長度 alphanumeric 既 span IDs。
6. 再用 cURL call Service A 既 HTTP REST endpoint。
7. 再檢查所有 microservices 既 console logs。
   • 應該會見到一個完全唔同既 trace ID。
   • 應該會見到每個 microservice 又有啲唔同既 span IDs。

1. 我地需要 set up 至少兩個 Spring Boot microservices。
2. 我地要配置好全部 microservices 既 logback.xml，將 <appender> 既 <destination> 配置為 127.0.0.1:5000，咁啲 logs 就會發送到本地部署既 Logstash。
3. 全部 microservices 都要 expose 至少一個 HTTP REST endpoints。
4. 除左最後一個只會被 call 但唔會 initiate call 既 microservice，我地要為所有作為 upstream 既其他 microservices 寫 HTTP call 既 code。
   • HTTP REST call flow：Service A ➜ Service B ➜ Service C 等等。
   • HTTP REST call 既 implementation 可以係 RestTemplate、WebClient、RestClient 或者 OpenFeign。
5. 用 cURL call Service A 既 HTTP REST endpoint。
6. 打開 http://localhost:5601 檢查我地喺 Kibana 既 data view。
   • 應該會見到只有一個 32 個位長度 alphanumeric 既 trace ID。
   • 應該會見到每個 microservice 都有啲唔同既 16 個位長度 alphanumeric 既 span IDs。
7. 再用 cURL call Service A 既 HTTP REST endpoint。
8. 再打開 http://localhost:5601 檢查我地喺 Kibana 既 data view。
   • 應該會見到一個完全唔同既 trace ID。
   • 應該會見到每個 microservice 又有啲唔同既 span IDs。
9. 我地可以撳落 traceId column 既某一個 cell value 隔籬既 ⊕ 號（「Filter for this traceId」），咁就可以睇曬所有同呢個 trace ID 有關係既 logs。

• Spring 官方 blog - Observability with Spring Boot 3
• Spring 官方文檔 - Observability Support
• GitHub - logfellow/logstash-logback-encoder - Logstash Logback Encoder - MDC fields
• OpenTelemetry - Traces
• GitHub - w3c/trace-context - Trace Context HTTP Request Headers Format