解决接入sleuth链路追踪后xxl-job定时任务的日志无日志问题

知北游z2024-06-19 2:31

问题背景

随着业务规模的不断的增大, 系统的复杂度也越来越高, 公司软件架构也进入到了分布式微服务的阶段, 在这样的情况下每一次请求都有可能跨越多个项目，传统的日志监控方式无法满足调用链路追踪, 这就导致问题定位/诊断服务变得复杂。所以我们引入了sleuth这一链路追踪框架为每一次请求的所有日志赋予一个traceId以方便日志的追溯。但是使用中发现xxl-job的日志是没有traceId的，只能根据线程id来筛选日志，且跨服务后的日志查不到了。为了解决这个问题，查阅了一些资料后找到了解决方案。

即通过使用Spring aop的方式在请求时向MDC注入traceId方法成功解决了这个问题。解决代码如下（@Before里的地址需要换成自己项目Job的类名）：

java 复制代码

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.codec.digest.DigestUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import java.util.UUID;

@Aspect
@Component
@Slf4j
public class JobTraceLogAspect {
 	private static final String TRACE_ID = "traceIdd";
    private static final String SPAN_ID = "spanId";
    
    @Before("execution(public * com.xxl.job..*.execute(String))")
    public void beforeMethod(JoinPoint joinPoint){
    	// 注入traceId
    	String val = UUID.randomUUID().toString().replace("-","");
        MDC.put(TRACE_ID, val);
        MDC.put(SPAN_ID, val);

		// 定时任务统一日志（如果不需要也可以去掉）
   		String className = joinPoint.getTarget().getClass().getSimpleName();
    	String methodName = joinPoint.getSignature().getName();
   		String args = JSON.toJSONString(joinPoint.getArgs(), SerializerFeature.IgnoreNonFieldGetter);
    	log.info("执行定时任务:{}.{},参数：{}", className, methodName, args);
    }
}

通过增加以上类，即可实现traceId注入，同时也增加了统一日志打印，不需要在每个定时任务入口都打印日志（如果不需要也可以去掉）。