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

Question

我在 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)
    }
}

Answer 1

如 Michael 所述，您可能需要实现 WebFilter 接口。由于 AWSXRayServletFilter 是一个 servlet 过滤器，它不能与 WebFilter 一起使用。遗憾的是，X-Ray SDK 中还没有针对 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 SDK 检测您的应用程序并使用 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

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

How to trace incoming requests with AWS X-Ray on Spring Boot WebFlux?

servlet-filters

netty

spring-boot

aws-xray

spring-webflux