用拦截器解决xxljob适配sleuth

在XXLJob项目中集成Sleuth实现任务调度日志追踪的问题与解决方案

原创已于 2024-02-06 14:43:12 修改 · 1.1k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#java #springcloud #springboot

于 2024-02-06 14:25:18 首次发布

文章描述了作者在使用XXLJob作为任务调度中心时遇到的问题，即调度任务的代码日志缺乏TraceId和SpanId。为便于问题追踪，作者尝试使用Sleuth的日志增强类并自定义了一个AOP拦截器添加这些ID。然而，当执行异步方法时，发现新的traceId和spanId会替换旧值，而非仅更新spanId，导致链路跟踪不清晰。

部署运行你感兴趣的模型镜像

项目中使用了xxljob做任务调度中心，使用过程中发现一个问题，xxljob调度的任务代码日志没有traceId和spanId等信息，为了放方便问题跟踪，所以要做适配。

网上调研，sleuth的日志增强类

org.springframework.cloud.sleuth.autoconfig.TraceEnvironmentPostProcessor
 
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment,
            SpringApplication application) {
        Map<String, Object> map = new HashMap<String, Object>();
        // This doesn't work with all logging systems but it's a useful default so you see
        // traces in logs without having to configure it.
        if (Boolean.parseBoolean(environment.getProperty("spring.sleuth.enabled", "true"))) {
            map.put("logging.pattern.level",
                    "%5p [${spring.zipkin.service.name:${spring.application.name:-}},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]");
        }
        addOrReplace(environment.getPropertySources(), map);
    }

所以按照这个思路我写了个拦截器来为使用@XxlJob注解的方法手动添加traceId和spanId

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;

import java.util.UUID;

@Aspect
@Component
@Slf4j
public class XxlJobInterceptor{
    private static final String TRACE_ID = "X-B3-TraceId";
    private static final String SPAN_ID = "X-B3-SpanId";
    private static final String SPAN_EXPORT = "X-Span-Export";

    @Around(value = "@annotation(com.xxl.job.core.handler.annotation.XxlJob)")
    public Object traceId(final ProceedingJoinPoint pjp) throws Throwable {
        try {
            String id = UUID.randomUUID().toString().replace("-","");
            MDC.put(TRACE_ID, id);
            MDC.put(SPAN_ID, id);
            MDC.put(SPAN_EXPORT, "true");
            return pjp.proceed();
        }finally {
            MDC.remove(TRACE_ID);
            MDC.remove(SPAN_ID);
            MDC.remove(SPAN_EXPORT);
        }
    }
}

测试了下，traceId和spanId都成功添加，然后我又测试了异步方法

    @XxlJob("test")
    public void testLog(){
        log.info("===================任务开始=====================");
        testService.test();
        log.info("===================任务结束=====================");
    }


@Service
@Slf4j
public class TestService {

    @Async
    public void test(){
        log.info("-----------------------------test-----------------------------------");
    }
}

发现一个问题，traceId和spanId虽然都还在，但都是一个新值，老的traceId无法保留。正常的情况应该是traceId仍然是老值，只有spanId变化，这样说明是一个链路中线程发生了转换，但是这里traceId和spanId都变化了，此问题尚未解决。

资料：SpringCloud Logback日志配置输出 sleuth 中的 span和traceid_logback如何打印spanid-优快云博客

您可能感兴趣的与本文相关的镜像