java 41 lines · 7 steps

Correlation IDs in a Spring WebFlux filter

A reactive WebFilter tags every request with a correlation ID and threads it through the Reactor context and logs.

Explained by highlit

Spring Advanced reactive web filter correlation id reactor context mdc logging

1@Component
2public class CorrelationIdWebFilter implements WebFilter, Ordered {
3 
  public static final String CORRELATION_ID_HEADER = "X-Correlation-Id";
  private static final String MDC_KEY = "correlationId";
  private static final String CONTEXT_KEY = "CONTEXT_CORRELATION_ID";
7 
  @Override
  public int getOrder() {
      return Ordered.HIGHEST_PRECEDENCE;
  }
12 
  @Override
  public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
      String correlationId = resolveCorrelationId(exchange.getRequest());
16 
      exchange.getResponse().getHeaders().set(CORRELATION_ID_HEADER, correlationId);
18 
      return chain.filter(exchange)
              .contextWrite(Context.of(CONTEXT_KEY, correlationId))
              .doOnEach(signal -> {
                  if (!signal.isOnComplete() && !signal.isOnError() && !signal.isOnNext()) {
                      return;
                  }
                  String id = signal.getContextView().getOrDefault(CONTEXT_KEY, correlationId);
                  try (MDC.MDCCloseable ignored = MDC.putCloseable(MDC_KEY, id)) {
                      if (signal.isOnError()) {
                          log.error("Request failed", signal.getThrowable());
                      }
                  }
              });
  }
33 
  private String resolveCorrelationId(ServerHttpRequest request) {
      String header = request.getHeaders().getFirst(CORRELATION_ID_HEADER);
      if (header != null && !header.isBlank()) {
          return header;
      }
      return UUID.randomUUID().toString();
  }
41}

01 / 01

STEP 01

Walkthrough

Space play ←→ step click any line

Three takeaways

1In reactive code, thread-local MDC won't survive across operators, so state must ride in the Reactor context instead.
2Running a filter at highest precedence guarantees the correlation ID exists before any downstream logic executes.
3Populating MDC only inside a try-with-resources at log time keeps thread-local state scoped and cleaned up correctly.

Related explainers

java

@Component
public class OrderRecoveryHandler {
 
    private final RabbitTemplate rabbitTemplate;

Dead-letter recovery with Spring AMQP

dead-letter-queue retry exponential-backoff

Advanced 9 steps

java

public final class DeepCopier {
 
    private static final ObjectMapper MAPPER = new ObjectMapper()
            .registerModule(new JavaTimeModule())

Deep-copying objects via Jackson serialization

serialization deep-copy generics

Intermediate 7 steps

java

package com.example.time;
 
import java.time.Duration;
import java.time.Instant;

Adding ISO-8601 durations across time zones in Java

date-time iso-8601 parsing

Intermediate 7 steps

java

@Component
public class InventoryReconciliationJob {
 
    private static final Logger log = LoggerFactory.getLogger(InventoryReconciliationJob.class);

Distributed scheduled jobs with Spring locks

distributed-locking scheduling concurrency

Advanced 8 steps

java

import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.regex.Pattern;

Ranking the most frequent words in Java

streams regex grouping

Intermediate 7 steps

java

public final class HttpHeaders {
 
    private final NavigableMap<String, List<String>> values =
            new TreeMap<>(String.CASE_INSENSITIVE_ORDER);