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

Question

我在AWS ECS上运行多个微服务，我想试用AWS X-Ray。根据这个开发者指南，我添加了一个带有跟踪过滤器的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添加额外的依赖项。我想这是因为我使用的是SpringBootWebFlux，而不是SpringBootWeb。所以我有一个Netty Web服务器，而不是Tomcat Web服务器。

我的问题是：

• 如何将日志添加到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一起使用。不幸的是，WebFlux的X-RaySDK中还没有内置支持。您需要做的是在您的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

或者，您可以使用OpenTelemeterJavaSDK来检测您的应用程序，并使用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