Spring Boot 4 + OpenTelemetry + Spring Cloud Gateway:全链路 TraceId 传播验证

Spring Boot 4 + OpenTelemetry + Spring Cloud Gateway 全链路 TraceId 传播验证

本文通过 Gateway、OpenFeign、API 三个服务验证 Spring Cloud Gateway 生成的 TraceId 能否通过 traceparent 依次传递给下游服务。验证链路为:网关 /feign → OpenFeign 服务 /feign → API 服务 /hello。最终三个服务日志中的 TraceId 保持一致,说明全链路传播生效。文中同时说明 Reactor 上下文传播、OpenFeign 自动传播和常见排查点。


1. 背景与验证目标

1.1 要解决的问题

在微服务链路中,一次用户请求可能经过网关、业务服务、下游 API 等多个节点。如果每个服务各自生成日志 TraceId,排查问题时无法把同一次请求的日志串起来。本文要验证的是:

  • Spring Cloud Gateway 是否能生成 TraceId;
  • 该 TraceId 是否能通过 HTTP Header 传给下游 OpenFeign 服务;
  • OpenFeign 服务是否能继续把同一个 TraceId 传给最终 API 服务;
  • 三个服务日志中的 TraceId 是否保持一致。

1.2 验证目标

通过网关访问 /feign 接口,该接口内部再通过 OpenFeign 访问 /hello 接口。验证链路:

text 复制代码
网关(hello-opentelemetry-traceid-propagation-gateway)
  → hello-opentelemetry-traceid-propagation-openfeign
  → hello-opentelemetry-traceid-propagation-api

验证成功标准:

  1. 网关日志中出现 TraceId;
  2. OpenFeign 服务收到的请求头中包含 traceparent;
  3. API 服务收到的请求头中包含 traceparent;
  4. 三个服务日志中的 TraceId 相同,SpanId 各自不同。

1.3 验证链路与端口规划

服务 端口 入口路径 下游
gateway 8082 /feign openfeign:8081 /feign
openfeign 8081 /feign api:8080 /hello
api 8080 /hello 无

1.4 版本与环境说明

组件 版本
Java 21
Spring Boot 4.1.2
Spring Cloud 2025.1.4
OpenTelemetry Starter spring-boot-starter-opentelemetry

2. 核心原理与关键配置

2.1 OpenTelemetry 自动埋点与 W3C traceparent

Spring Boot 4 提供了 spring-boot-starter-opentelemetry,引入后会自动完成 OpenTelemetry 的自动配置,包括:

  • 为 HTTP 请求生成 TraceId / SpanId;
  • 通过 W3C Trace Context 标准在服务间传播上下文;
  • 将 TraceId / SpanId 注入日志 MDC,日志格式中即可打印 [traceId-spanId]。

W3C Trace Context 的核心请求头是:

text 复制代码
traceparent: 00-<trace-id>-<parent-span-id>-<trace-flags>

例如本文中网关生成的 traceparent 为:

text 复制代码
00-6bac682264352663d6e78a780443b5a5-96e5389e3c9d8ef4-02

其中 6bac682264352663d6e78a780443b5a5 就是贯穿全链路的 TraceId。

2.2 Spring Cloud Gateway 的响应式上下文传播

Spring Cloud Gateway 基于 WebFlux / Reactor,请求处理过程中会频繁切换线程。如果只依赖 ThreadLocal 保存 Trace 上下文,线程切换后 MDC 中的 TraceId 就会丢失。因此网关必须开启 Reactor 上下文传播:

yml 复制代码
spring:
  reactor:
    context-propagation: auto

该配置让 Reactor 在操作符切换线程时自动传递上下文,保证日志中始终能打印出正确的 TraceId。

2.3 OpenFeign 调用链传播

OpenFeign 服务引入 spring-boot-starter-opentelemetry 与 feign-micrometer 后,OpenTelemetry 会自动为 Feign 调用创建 Span,并把当前上下文通过 traceparent 请求头传给下游服务。因此 OpenFeign 服务无需手写传播逻辑。

2.4 三个服务的关键配置一览

服务 关键依赖 关键配置
gateway spring-boot-starter-opentelemetry、spring-cloud-starter-gateway-server-webflux spring.reactor.context-propagation=auto、路由配置
openfeign spring-boot-starter-opentelemetry、spring-cloud-starter-openfeign、feign-micrometer @EnableFeignClients、Feign 客户端
api spring-boot-starter-opentelemetry、spring-boot-starter-webmvc 无特殊配置

3. 工程结构与启动准备

3.1 三个模块的职责

创建三个 Spring Boot 工程:

  • hello-opentelemetry-traceid-propagation-gateway:网关服务,负责生成并向下游传播 TraceId;
  • hello-opentelemetry-traceid-propagation-openfeign:中间服务,接收请求并通过 OpenFeign 调用 API;
  • hello-opentelemetry-traceid-propagation-api:最终 API 服务,打印收到的请求头并返回结果。

3.2 启动顺序

建议启动顺序为:

text 复制代码
api(8080) → openfeign(8081) → gateway(8082)

3.3 验证入口

浏览器或命令行访问:

text 复制代码
http://localhost:8082/feign

4. 网关服务实现:生成并传递 TraceId

4.1 关键依赖

xml 复制代码
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway-server-webflux</artifactId>
        </dependency>

完整 POM 见附录 A。

4.2 路由配置

yml 复制代码
spring:
  application:
    name: hello-opentelemetry-traceid-propagation-gateway
  cloud:
    gateway:
      server:
        webflux:
          routes:
            - id: hello-opentelemetry-traceid-propagation-api  # 路由唯一标识
              uri: http://localhost:8080  # 目标服务地址
              predicates:
                - Path=/hello  # 断言:精确匹配 /hello 路径的请求
            - id: hello-opentelemetry-traceid-propagation-openfeign  # 路由唯一标识
              uri: http://localhost:8081  # 目标服务地址
              predicates:
                - Path=/feign  # 断言:精确匹配 /feign 路径的请求
  reactor:
    context-propagation: auto  # 开启 Reactor 上下文传播:自动传递Trace上下文到MDC,解决响应式线程切换丢失问题

server:
  port: 8082

# 关闭 OTLP 指标上报
management:
  otlp:
    metrics:
      export:
        enabled: false

4.3 Reactor 上下文传播配置说明

spring.reactor.context-propagation: auto 是网关日志能打印 TraceId 的关键。没有它,TraceLogFilter 中的 log.info 在线程切换后可能拿不到 MDC 中的 TraceId。

4.4 TraceLogFilter:打印带 TraceId 的网关日志

java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_gateway.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Slf4j
@Component
public class TraceLogFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String method = exchange.getRequest().getMethod().name();
        String path = exchange.getRequest().getURI().getPath();

        // 请求进入网关时打印(此时OTel已自动生成TraceId)
        log.info("网关接收请求: {} {}", method, path);

        return chain.filter(exchange)
                .doOnSuccess(unused -> log.info("网关转发成功: {} {}", method, path))
                .doOnError(e -> log.error("网关转发失败: {} {}", method, path, e));
    }

    @Override
    public int getOrder() {
        // 优先级设为最高,确保在路由逻辑前执行
        return Ordered.HIGHEST_PRECEDENCE;
    }
}

4.5 网关日志验证

bash 复制代码
2026-11-14T18:04:10.296+08:00  INFO 13352 --- [hello-opentelemetry-traceid-propagation-gateway] [ctor-http-nio-2] [6bac682264352663d6e78a780443b5a5-dd4ac1e34760a254] c.e.h.filter.TraceLogFilter              : 网关接收请求: GET /feign
2026-11-14T18:04:10.895+08:00  INFO 13352 --- [hello-opentelemetry-traceid-propagation-gateway] [ctor-http-nio-2] [6bac682264352663d6e78a780443b5a5-dd4ac1e34760a254] c.e.h.filter.TraceLogFilter              : 网关转发成功: GET /feign

日志中的 [6bac682264352663d6e78a780443b5a5-dd4ac1e34760a254] 即 [traceId-spanId],说明网关已生成 TraceId。


5. OpenFeign 服务实现:接收并继续传播 TraceId

5.1 关键依赖

xml 复制代码
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-micrometer</artifactId>
        </dependency>

完整 POM 见附录 B。

5.2 HelloController:打印请求头与调用日志

java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_openfeign.hello;

import com.example.hello_opentelemetry_traceid_propagation_openfeign.feign.HelloFeignClient;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.node.ObjectNode;

import java.util.Collections;
import java.util.Enumeration;

@Slf4j
@RestController
@RequiredArgsConstructor
public class HelloController {

    private final ObjectMapper objectMapper;
    private final HelloFeignClient helloFeignClient;

    @GetMapping("/feign")
    public String callFeign(HttpServletRequest request) {
        ObjectNode headerJson = objectMapper.createObjectNode();
        Enumeration<String> headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String name = headerNames.nextElement();
            Enumeration<String> valuesEnum = request.getHeaders(name);
            String value = String.join(",", Collections.list(valuesEnum));
            headerJson.put(name, value);
        }
        log.info("JSON格式请求头 = {}", headerJson);

        log.info("调用下游 OpenFeign 接口开始");
        String hello = helloFeignClient.hello();
        log.info("调用下游 OpenFeign 接口完成,返回结果 = {}", hello);
        return "你好,世界!";
    }

}

5.3 HelloFeignClient:调用下游 API

java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_openfeign.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

@FeignClient(contextId = "HelloFeignClient", name = "hello-opentelemetry-traceid-propagation-api", url = "http://localhost:8080")
public interface HelloFeignClient {

    @GetMapping("/hello")
    String hello();

}

5.4 服务日志验证

bash 复制代码
2026-11-14T18:04:10.773+08:00  INFO 6184 --- [hello-opentelemetry-traceid-propagation-openfeign] [nio-8081-exec-7] [6bac682264352663d6e78a780443b5a5-f3fdb00c9f6b5e8e] c.e.h.hello.HelloController              : JSON格式请求头 = {"Cache-Control":"max-age=0","sec-ch-ua":"\"Not-A.Brand\";v=\"99\", \"Microsoft Edge\";v=\"157\", \"Chromium\";v=\"157\"","sec-ch-ua-mobile":"?0","sec-ch-ua-platform":"\"Windows\"","Upgrade-Insecure-Requests":"1","User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/157.0.0.0 Safari/537.36 Edg/157.0.0.0","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7","Sec-Fetch-Site":"none","Sec-Fetch-Mode":"navigate","Sec-Fetch-User":"?1","Sec-Fetch-Dest":"document","Accept-Encoding":"gzip, deflate, br, zstd","Accept-Language":"zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6","traceparent":"00-6bac682264352663d6e78a780443b5a5-96e5389e3c9d8ef4-02","host":"localhost:8081"}
2026-11-14T18:04:10.775+08:00  INFO 6184 --- [hello-opentelemetry-traceid-propagation-openfeign] [nio-8081-exec-7] [6bac682264352663d6e78a780443b5a5-f3fdb00c9f6b5e8e] c.e.h.hello.HelloController              : 调用下游 OpenFeign 接口开始
2026-11-14T18:04:10.794+08:00  INFO 6184 --- [hello-opentelemetry-traceid-propagation-openfeign] [nio-8081-exec-7] [6bac682264352663d6e78a780443b5a5-f3fdb00c9f6b5e8e] c.e.h.hello.HelloController              : 调用下游 OpenFeign 接口完成,返回结果 = Hello World

可以看到:

  • 请求头中已包含网关传入的 traceparent;
  • 日志 TraceId 与网关一致;
  • SpanId 已切换为 OpenFeign 服务自己的 SpanId。

6. API 服务实现:接收最终请求

6.1 关键依赖

xml 复制代码
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc</artifactId>
        </dependency>

完整 POM 见附录 C。

6.2 HelloController:打印请求头

java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_api.hello;

import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.node.ObjectNode;

import java.util.Collections;
import java.util.Enumeration;

@Slf4j
@RestController
@RequiredArgsConstructor
public class HelloController {

    private final ObjectMapper objectMapper;

    @GetMapping("/hello")
    public String hello(HttpServletRequest request) {
        ObjectNode headerJson = objectMapper.createObjectNode();
        Enumeration<String> headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String name = headerNames.nextElement();
            Enumeration<String> valuesEnum = request.getHeaders(name);
            String value = String.join(",", Collections.list(valuesEnum));
            headerJson.put(name, value);
        }
        log.info("JSON格式请求头 = {}", headerJson);

        return "Hello World";
    }

}

6.3 服务日志验证

bash 复制代码
2026-11-14T18:04:10.788+08:00  INFO 19840 --- [hello-opentelemetry-traceid-propagation-api] [nio-8080-exec-7] [6bac682264352663d6e78a780443b5a5-70889a0de8277d3b] c.e.h.hello.HelloController              : JSON格式请求头 = {"traceparent":"00-6bac682264352663d6e78a780443b5a5-24d1b5a8b75c6731-02","Accept":"*/*","User-Agent":"Java/21.0.1","Host":"localhost:8080","Connection":"keep-alive"}

API 服务收到的 traceparent 中 TraceId 仍为 6bac682264352663d6e78a780443b5a5,说明 OpenFeign 已自动继续向下游传播。


7. 全链路验证结果

7.1 请求路径与验证步骤

请求入口:

text 复制代码
http://localhost:8082/feign

验证步骤:

  1. 启动三个服务;
  2. 访问网关 /feign;
  3. 查看网关日志;
  4. 查看 OpenFeign 服务日志;
  5. 查看 API 服务日志;
  6. 对比三个服务的 TraceId。

7.2 三个服务的 TraceId 对比

服务 日志中的 TraceId SpanId 示例 说明
gateway 6bac682264352663d6e78a780443b5a5 dd4ac1e34760a254 网关生成 / 接收 Trace
openfeign 6bac682264352663d6e78a780443b5a5 f3fdb00c9f6b5e8e TraceId 一致
api 6bac682264352663d6e78a780443b5a5 70889a0de8277d3b TraceId 一致

7.3 traceparent 请求头传播说明

节点 收到的 traceparent
openfeign 服务 00-6bac682264352663d6e78a780443b5a5-96e5389e3c9d8ef4-02
api 服务 00-6bac682264352663d6e78a780443b5a5-24d1b5a8b75c6731-02

TraceId 部分完全一致,SpanId 不同,符合一次请求跨服务传播的预期。

7.4 验证结论

  1. Spring Cloud Gateway 可以生成 TraceId,并向下游传播;
  2. OpenFeign 服务能接收到网关传入的 traceparent,并继续传给 API;
  3. API 服务收到的 TraceId 与网关一致;
  4. 三个服务日志中的 TraceId 完全一致,全链路 TraceId 传播验证成功。

8. 常见问题与排查建议

8.1 网关日志没有 TraceId

检查是否配置了:

yml 复制代码
spring:
  reactor:
    context-propagation: auto

未开启时,Reactor 线程切换后 MDC 中的 TraceId 可能丢失。

8.2 OpenFeign 下游没有收到 traceparent

  • 检查是否引入 spring-boot-starter-opentelemetry;
  • 检查是否引入 feign-micrometer;
  • 检查 OpenFeign 服务是否正常启动并注册了 Feign 客户端。

8.3 OTLP 指标上报报错或不需要指标

本文验证只关注 TraceId 传播,不涉及指标上报,三个服务均关闭了 OTLP 指标上报:

yml 复制代码
management:
  otlp:
    metrics:
      export:
        enabled: false

如果本地没有 OTLP Collector,建议保留该配置,避免启动时报连接错误。

8.4 版本兼容与依赖冲突

  • Spring Boot 4.x 需搭配 Spring Cloud 2025.x;
  • 三个服务尽量使用相同的 Spring Boot / Spring Cloud 版本;
  • 网关使用 WebFlux 栈,业务服务使用 WebMVC 栈,注意不要混用 Starter。

9. 总结

本文通过 Gateway、OpenFeign、API 三个服务验证了 Spring Boot 4 + OpenTelemetry 的全链路 TraceId 传播能力,结论如下:

  1. Spring Cloud Gateway 能生成 TraceId,并通过 traceparent 传给下游;
  2. 网关作为响应式服务,必须开启 spring.reactor.context-propagation=auto,否则日志中可能丢失 TraceId;
  3. OpenFeign 服务引入 OTel Starter 与 feign-micrometer 后,可自动继续传播 TraceId;
  4. 三个服务日志中的 TraceId 完全一致,SpanId 各不相同,符合分布式追踪预期;
  5. 该方案可作为微服务全链路日志追踪的最小可复现样例。

本文完整验证通过。 三个服务日志中的 TraceId 均为 6bac682264352663d6e78a780443b5a5,SpanId 各自不同,证明 Spring Boot 4 + OpenTelemetry + Spring Cloud Gateway + OpenFeign 的全链路 TraceId 传播机制工作正常。


附录:完整工程代码

附录 A:网关服务完整代码

A.1. POM
xml 复制代码
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>4.1.2</version>
        <relativePath/>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>hello-opentelemetry-traceid-propagation-gateway</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <java.version>21</java.version>
        <spring-cloud.version>2025.1.4</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway-server-webflux</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>io.projectreactor</groupId>
            <artifactId>reactor-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <executions>
                    <execution>
                        <id>default-compile</id>
                        <phase>compile</phase>
                        <goals>
                            <goal>compile</goal>
                        </goals>
                        <configuration>
                            <annotationProcessorPaths>
                                <path>
                                    <groupId>org.projectlombok</groupId>
                                    <artifactId>lombok</artifactId>
                                </path>
                            </annotationProcessorPaths>
                        </configuration>
                    </execution>
                    <execution>
                        <id>default-testCompile</id>
                        <phase>test-compile</phase>
                        <goals>
                            <goal>testCompile</goal>
                        </goals>
                        <configuration>
                            <annotationProcessorPaths>
                                <path>
                                    <groupId>org.projectlombok</groupId>
                                    <artifactId>lombok</artifactId>
                                </path>
                            </annotationProcessorPaths>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>
A.2. application.yml
yml 复制代码
spring:
  application:
    name: hello-opentelemetry-traceid-propagation-gateway
  cloud:
    gateway:
      server:
        webflux:
          routes:
            - id: hello-opentelemetry-traceid-propagation-api  # 路由唯一标识
              uri: http://localhost:8080  # 目标服务地址
              predicates:
                - Path=/hello  # 断言:精确匹配 /hello 路径的请求
            - id: hello-opentelemetry-traceid-propagation-openfeign  # 路由唯一标识
              uri: http://localhost:8081  # 目标服务地址
              predicates:
                - Path=/feign  # 断言:精确匹配 /feign 路径的请求
  reactor:
    context-propagation: auto  # 开启 Reactor 上下文传播:自动传递Trace上下文到MDC,解决响应式线程切换丢失问题

server:
  port: 8082

# 关闭 OTLP 指标上报
management:
  otlp:
    metrics:
      export:
        enabled: false
A.3. 启动类
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class HelloOpentelemetryTraceidPropagationGatewayApplication {

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

}
A.4. TraceLogFilter
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_gateway.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Slf4j
@Component
public class TraceLogFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String method = exchange.getRequest().getMethod().name();
        String path = exchange.getRequest().getURI().getPath();

        // 请求进入网关时打印(此时OTel已自动生成TraceId)
        log.info("网关接收请求: {} {}", method, path);

        return chain.filter(exchange)
                .doOnSuccess(unused -> log.info("网关转发成功: {} {}", method, path))
                .doOnError(e -> log.error("网关转发失败: {} {}", method, path, e));
    }

    @Override
    public int getOrder() {
        // 优先级设为最高,确保在路由逻辑前执行
        return Ordered.HIGHEST_PRECEDENCE;
    }
}

附录 B:OpenFeign 服务完整代码

B.1. POM
xml 复制代码
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>4.1.2</version>
        <relativePath/>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>hello-opentelemetry-traceid-propagation-openfeign</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <java.version>21</java.version>
        <spring-cloud.version>2025.1.4</spring-cloud.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-micrometer</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <executions>
                    <execution>
                        <id>default-compile</id>
                        <phase>compile</phase>
                        <goals>
                            <goal>compile</goal>
                        </goals>
                        <configuration>
                            <annotationProcessorPaths>
                                <path>
                                    <groupId>org.projectlombok</groupId>
                                    <artifactId>lombok</artifactId>
                                </path>
                            </annotationProcessorPaths>
                        </configuration>
                    </execution>
                    <execution>
                        <id>default-testCompile</id>
                        <phase>test-compile</phase>
                        <goals>
                            <goal>testCompile</goal>
                        </goals>
                        <configuration>
                            <annotationProcessorPaths>
                                <path>
                                    <groupId>org.projectlombok</groupId>
                                    <artifactId>lombok</artifactId>
                                </path>
                            </annotationProcessorPaths>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>
B.2. application.yml
yml 复制代码
spring:
  application:
    name: hello-opentelemetry-traceid-propagation-openfeign

server:
  port: 8081

# 关闭 OTLP 指标上报
management:
  otlp:
    metrics:
      export:
        enabled: false
B.3. 启动类
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_openfeign;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@EnableFeignClients
@SpringBootApplication
public class HelloOpentelemetryTraceidPropagationOpenfeignApplication {

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

}
B.4. HelloController
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_openfeign.hello;

import com.example.hello_opentelemetry_traceid_propagation_openfeign.feign.HelloFeignClient;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.node.ObjectNode;

import java.util.Collections;
import java.util.Enumeration;

@Slf4j
@RestController
@RequiredArgsConstructor
public class HelloController {

    private final ObjectMapper objectMapper;
    private final HelloFeignClient helloFeignClient;

    @GetMapping("/feign")
    public String callFeign(HttpServletRequest request) {
        ObjectNode headerJson = objectMapper.createObjectNode();
        Enumeration<String> headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String name = headerNames.nextElement();
            Enumeration<String> valuesEnum = request.getHeaders(name);
            String value = String.join(",", Collections.list(valuesEnum));
            headerJson.put(name, value);
        }
        log.info("JSON格式请求头 = {}", headerJson);

        log.info("调用下游 OpenFeign 接口开始");
        String hello = helloFeignClient.hello();
        log.info("调用下游 OpenFeign 接口完成,返回结果 = {}", hello);
        return "你好,世界!";
    }

}
B.5. HelloFeignClient
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_openfeign.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

@FeignClient(contextId = "HelloFeignClient", name = "hello-opentelemetry-traceid-propagation-api", url = "http://localhost:8080")
public interface HelloFeignClient {

    @GetMapping("/hello")
    String hello();

}

附录 C:API 服务完整代码

C.1. POM
xml 复制代码
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>4.1.2</version>
        <relativePath/>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>hello-opentelemetry-traceid-propagation-api</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <java.version>21</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-opentelemetry-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webmvc-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <executions>
                    <execution>
                        <id>default-compile</id>
                        <phase>compile</phase>
                        <goals>
                            <goal>compile</goal>
                        </goals>
                        <configuration>
                            <annotationProcessorPaths>
                                <path>
                                    <groupId>org.projectlombok</groupId>
                                    <artifactId>lombok</artifactId>
                                </path>
                            </annotationProcessorPaths>
                        </configuration>
                    </execution>
                    <execution>
                        <id>default-testCompile</id>
                        <phase>test-compile</phase>
                        <goals>
                            <goal>testCompile</goal>
                        </goals>
                        <configuration>
                            <annotationProcessorPaths>
                                <path>
                                    <groupId>org.projectlombok</groupId>
                                    <artifactId>lombok</artifactId>
                                </path>
                            </annotationProcessorPaths>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>
C.2. application.yml
yml 复制代码
spring:
  application:
    name: hello-opentelemetry-traceid-propagation-api

# 关闭 OTLP 指标上报
management:
  otlp:
    metrics:
      export:
        enabled: false
C.3. 启动类
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_api;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class HelloOpentelemetryTraceidPropagationApiApplication {

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

}
C.4. HelloController
java 复制代码
package com.example.hello_opentelemetry_traceid_propagation_api.hello;

import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.node.ObjectNode;

import java.util.Collections;
import java.util.Enumeration;

@Slf4j
@RestController
@RequiredArgsConstructor
public class HelloController {

    private final ObjectMapper objectMapper;

    @GetMapping("/hello")
    public String hello(HttpServletRequest request) {
        ObjectNode headerJson = objectMapper.createObjectNode();
        Enumeration<String> headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String name = headerNames.nextElement();
            Enumeration<String> valuesEnum = request.getHeaders(name);
            String value = String.join(",", Collections.list(valuesEnum));
            headerJson.put(name, value);
        }
        log.info("JSON格式请求头 = {}", headerJson);

        return "Hello World";
    }

}
相关推荐
下一站春风里1 小时前
Spring IoC 控制反转 完整技术笔记
java·spring boot·笔记·spring
小码哥0681 小时前
Spring Boot在线租房系统源码:UniApp找房、VR展示与预约管理落地解析
spring boot·租房小程序·租房系统·在线租房
芜名氏2 小时前
API 文档生成工具——SpringDoc
java·spring boot·ci/cd·设计规范
乌暮1 天前
Spring AOP 与 Spring 事务:用大白话彻底理解原理与实践
java·数据库·spring boot·后端·sql·学习·spring
小荷才露尖尖角,早有蜻蜓立上头1 天前
SpringBoot+QQ邮箱发送邮件
spring boot
头发还在的女程序员1 天前
Java在线租房系统源码解析:Spring Boot+Vue 3+UniApp房源管理与预约看房方案
java·vue.js·spring boot·租房小程序·租房系统·租房软件
FYKJ_20101 天前
springboot同人周边订单管理系统48955-计算机毕业设计、课程设计
java·javascript·vue.js·spring boot·django·php·课程设计
Flynn Liang2 天前
可观测性与成本治理:一次对话的 17 个观测点
java·langchain·可观测性·micrometer·langchain4j·token 成本·llm 监控
yuyuxun12 天前
协同过滤的校园二手物品智能推荐系统的设计与实现 毕业设计-附源码40082
javascript·vue.js·spring boot·python·数据分析·django·课程设计