使用SpringWebFlux实现跟踪id

Question

我希望为每个请求生成唯一的traceId，并将其传递给所有服务。在SpringMVC中，使用MDC上下文并将traceId放在头文件中相当容易，但在反应式堆栈中，由于ThreadLocal，它根本不起作用。

一般来说，我希望使用单个traceId记录我拥有的每个服务上的每个请求和响应，该traceId可以识别整个系统中的特定操作。

我试图根据文章创建自定义过滤器：https://azizulhaq-ananto.medium.com/how-to-handle-logs-and-tracing-in-spring-webflux-and-microservices-a0b45adc4610但它似乎不起作用。我目前的解决方案只有日志响应和TraceId在发出请求后丢失，所以没有on响应。让我们试着想象有两个服务：service1和service2。下面我试着勾勒出它应该如何工作。

它应该如何工作

1. 客户端-

它实际上是如何工作的

1. 客户端-

这是我的做法

@Component
public class TraceIdFilter implements WebFilter {

    private static final Logger log = LoggerFactory.getLogger(TraceIdFilter.class);

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        Map<String, String> headers = exchange.getRequest().getHeaders().toSingleValueMap();
        return Mono.fromCallable(() ->  {
            final long startTime = System.currentTimeMillis();

            return new ServerWebExchangeDecorator(exchange) {
                @Override
                public ServerHttpRequest getRequest() {
                    return new RequestLoggingInterceptor(super.getRequest(), false);
                }

                @Override
                public ServerHttpResponse getResponse() {
                    return new ResponseLoggingInterceptor(super.getResponse(), startTime, false);
                }
            };
        }).contextWrite(context -> {
            var traceId = "";
            if (headers.containsKey("X-B3-TRACEID")) {
                traceId = headers.get("X-B3-TRACEID");
                MDC.put("X-B3-TraceId", traceId);
            } else if (!exchange.getRequest().getURI().getPath().contains("/actuator")) {
                traceId = UUID.randomUUID().toString();
                MDC.put("X-B3-TraceId", traceId);
            }

            Context contextTmp = context.put("X-B3-TraceId", traceId);
            exchange.getAttributes().put("X-B3-TraceId", traceId);


            return contextTmp;
        }).flatMap(chain::filter);

    }


}

Github：https://github.com/Faelivrinx/kotlin-spring-boot

有什么现有的解决方案吗？

Answer 1

在SpringWebFlow中，您不再拥有ThreadLocal，但是您对每个链请求都有一个独特的上下文。您可以附加一个跟踪到这个上下文如下：

@Component
public class TraceIdFilter implements WebFilter {

    private static final Logger log = LoggerFactory.getLogger(TraceIdFilter.class);

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {

        return chain.filter(exchange)
                .subscriberContext(
                        ctx -> {
                            .....
                            var traceId = UUID.randomUUID().toString();
                            return   ctx.put("X-B3-TraceId", traceId);
                            .....
                        }
                );

    }


}

现在，服务中的链将在上下文中具有此属性。您可以使用静态方法Mono.subscriberContext（）从服务中检索它。例如，您可以通过这种方式获取traceId

Mono.subscriberContext()
    .flaMap(ctx -> {
       .....
       var traceId = ctx.getOrDefault("traceId", null);
       .....
    )