如何在 Spring Boot WebFlux 上使用 AWS X-Ray 跟踪传入请求？

Posted 2023-02-27

【中文标题】如何在 Spring Boot WebFlux 上使用 AWS X-Ray 跟踪传入请求？

【英文标题】：How to trace incoming requests with AWS X-Ray on Spring Boot WebFlux?

【发布时间】：2021-04-20 08:00:10

【问题描述】：

我在 AWS ECS 上运行了多个微服务，我想试用 AWS X-Ray。在this developer guide 之后，我添加了一个带有跟踪过滤器的WebConfig.java 文件。

向build.gradle添加行：

implementation "javax.servlet:javax.servlet-api:4.0.1"
implementation "com.amazonaws:aws-xray-recorder-sdk-core:2.8.0"

新文件WebConfig.java：

import com.amazonaws.xray.javax.servlet.AWSXRayServletFilter;
import javax.servlet.Filter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class WebConfig 

  @Bean
  public Filter tracingFilter() 
    return new AWSXRayServletFilter("ordermicroservice");
  

但是，我不认为这是正确的，主要是因为我必须为 javax.servlet.Filter 添加额外的依赖项。我认为这是因为我使用的是 spring-boot-webflux 而不是 spring-boot-web。所以我有一个 Netty 网络服务器，而不是 Tomcat 网络服务器。

我的问题是：

如何向 servlet 过滤器添加日志记录，以确保每个传入的 HTTP 请求都正确地通过过滤器？ 在使用 Netty 而不是 Tomcat 的 spring-boot-webflux 项目中编写 Web 过滤器的正确方法是什么？

编辑： 到目前为止，我想出了如何使用 Spring Boot WebFlux 编写过滤器。我将在此处将其添加到问题中以供将来参考：

import org.springframework.stereotype.Component
import org.springframework.web.server.ServerWebExchange
import org.springframework.web.server.WebFilter
import org.springframework.web.server.WebFilterChain
import reactor.core.publisher.Mono

@Component
class MyCustomWebFilter : WebFilter 

    override fun filter(webExchange: ServerWebExchange, chain: WebFilterChain): Mono<Void> 
        print("Successfully reached the WebFilter.\n")

        val request = webExchange.request
        val response = webExchange.response

        // TODO: Do the actual filtering by looking at the request and modifying the response

        return chain.filter(webExchange)
    

【问题讨论】：

你是对的。当您使用 webflux 时，servlet 过滤器将不起作用。与 webflux 中的 servlet 过滤器等效的是 WebFilter。您需要做的就是创建 WebFilter 接口的新实现并向其添加组件注释。 docs.spring.io/spring-framework/docs/current/javadoc-api/org/…

【参考方案1】：

正如 Michael 所说，您可能需要实现 WebFilter 接口。由于 AWSXRayServletFilter 是一个 servlet 过滤器，因此它不适用于 WebFilter。不幸的是，X-Ray SDK for WebFlux 中还没有内置支持。你需要做的是在你的 WebFilter 链中，实现你自己的拦截器，通过创建一个段并向它添加相关数据来跟踪传入的请求。您可以在此处参考 AWSXRayServletFilter 如何跟踪传入请求：https://github.com/aws/aws-xray-sdk-java/blob/master/aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/javax/servlet/AWSXRayServletFilter.java

或者，您可以使用 OpenTelemetry Java 开发工具包来检测您的应用程序并使用 AWS Collector 将跟踪数据发送到 X-Ray。 OTel SDK 支持 WebFlux 框架。您可以在下面找到更多信息。

OTel Java SDK 检测：https://github.com/open-telemetry/opentelemetry-java-instrumentation

AWS OTel 收集器：https://aws-otel.github.io/docs/getting-started/collector

【讨论】：

好的，所以为了完全清楚，我必须自己编写代码，查看传入请求的标头，如果还没有 x-ray-tracing-header，则添加它传出响应？

大部分是的。您必须自己编写大量代码来跟踪传入的请求。如果您不打算在任何地方使用它，您可能不需要将 X 射线追踪标头添加到传出响应中。关键部分是拦截请求、创建段、向段添加所需数据、在响应返回时结束段。

另请参阅上面我的回答中使用 OpenTelemetry 的替代方法。