Spring Boot异步任务日志TraceId与Span为空问题求助

核心原因 #

异步任务默认不会自动继承主线程的Trace上下文，导致callExternalApiAndReturnResponse方法执行时，MDC中的trace/span ID为空。即使注入了TraceableExecutorService，如果没有正确处理上下文的捕获与恢复，也无法传递TraceId。

解决方案 #

方案1：手动捕获并恢复Trace上下文（推荐） #

利用Spring Cloud Sleuth的TraceContext工具，在主线程捕获当前上下文，然后在异步任务中临时恢复：

// 注入SleuthTracer
@Autowired
private SleuthTracer tracer;

// 注入自定义的TraceableExecutorService
@Autowired
private Executor traceableExecutor;

public void yourRestEndpointMethod() {
    // 主线程中捕获当前Trace上下文
    TraceContext currentTraceContext = tracer.currentTraceContext().context();

    CompletableFuture<YourResponse> future = CompletableFuture.supplyAsync(() -> {
        // 在异步任务中恢复Trace上下文，try-with-resources确保自动清理
        try (var scope = tracer.currentTraceContext().newScope(currentTraceContext)) {
            return callExternalApiAndReturnResponse(url, request);
        }
    }, traceableExecutor);

    // 后续处理逻辑...
}

方案2：使用ContextSnapshot简化上下文传递 #

Spring Boot 2.3+提供了ContextSnapshot工具，可以更简洁地捕获和恢复上下文：

@Autowired
private Executor traceableExecutor;

public void yourRestEndpointMethod() {
    // 捕获当前上下文快照
    ContextSnapshot snapshot = ContextSnapshot.capture();

    CompletableFuture<YourResponse> future = CompletableFuture.supplyAsync(() -> {
        // 恢复上下文，try-with-resources自动清理
        try (var ignored = snapshot.restore()) {
            return callExternalApiAndReturnResponse(url, request);
        }
    }, traceableExecutor);

    // 后续处理逻辑...
}

关键配置检查 #

1. 确保TraceableExecutorService正确配置
   要创建被Sleuth代理的线程池，而不是普通的ExecutorService：

   @Bean
   public Executor traceableExecutor(SleuthTracer tracer) {
       ExecutorService threadPool = Executors.newFixedThreadPool(10);
       return new TraceableExecutorService(threadPool, tracer);
   }
   

2. 日志配置包含Trace/Span ID
   确保你的日志框架（如Logback）配置中添加了MDC变量：

   <!-- Logback示例 -->
   <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg %X{traceId} %X{spanId}%n</pattern>
   

3. RestTemplate被Sleuth代理
   不要手动创建RestTemplate，而是通过RestTemplateBuilder注入，确保Sleuth自动添加追踪拦截器：

   @Bean
   public RestTemplate restTemplate(RestTemplateBuilder builder) {
       return builder.build();
   }
   

内容的提问来源于stack exchange，提问作者Aditi