0
0

SpringBoot使用TraceId日志链路追踪

项目场景：

  1.   有时候一个业务调用链场景，很长，调了各种各样的方法，看日志的时候，各个接口的日志穿插，确实让人头大。为了解决这个痛点，就使用了TraceId，根据TraceId关键字进入服务器查询日志中是否有这个TraceId，这样就把同一次的业务调用链上的日志串起来了。

实现步骤

1、pom.xml 依赖

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.springframework.boot</groupId>
  4.         <artifactId>spring-boot-starter-web</artifactId>
  5.     </dependency>
  6.     <dependency>
  7.         <groupId>org.springframework.boot</groupId>
  8.         <artifactId>spring-boot-starter-test</artifactId>
  9.         <scope>test</scope>
  10.     </dependency>
  11.     <dependency>
  12.         <groupId>org.springframework.boot</groupId>
  13.         <artifactId>spring-boot-starter-logging</artifactId>
  14.     </dependency>
  15.     <!--lombok配置-->
  16.     <dependency>
  17.         <groupId>org.projectlombok</groupId>
  18.         <artifactId>lombok</artifactId>
  19.         <version>1.16.10</version>
  20.     </dependency>
  21. </dependencies>

2、整合logback，打印日志，logback-spring.xml (简单配置下)

关键代码：[traceId:%X{traceId}]，traceId是通过拦截器里MDC.put(traceId, tid)添加

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration debug="false">
  3.     <!--日志存储路径-->
  4.     <property name="log" value="D:/test/log" />
  5.     <!-- 控制台输出 -->
  6.     <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  7.         <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
  8.             <!--输出格式化-->
  9.             <pattern>[traceId:%X{traceId}]  %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  10.         </encoder>
  11.     </appender>
  12.     <!-- 按天生成日志文件 -->
  13.     <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  14.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  15.             <!--日志文件名-->
  16.             <FileNamePattern>${log}/%d{yyyy-MM-dd}.log</FileNamePattern>
  17.             <!--保留天数-->
  18.             <MaxHistory>30</MaxHistory>
  19.         </rollingPolicy>
  20.         <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
  21.             <pattern>[traceId:%X{traceId}]  %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  22.         </encoder>
  23.         <!--日志文件最大的大小-->
  24.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  25.             <MaxFileSize>10MB</MaxFileSize>
  26.         </triggeringPolicy>
  27.     </appender>
  28.  
  29.     <!-- 日志输出级别 -->
  30.     <root level="INFO">
  31.         <appender-ref ref="console" />
  32.         <appender-ref ref="file" />
  33.     </root>
  34. </configuration>

3、application.yml

  1. server:
  2.   port: 8826
  3. logging:
  4.   config: classpath:logback-spring.xml

4、自定义日志拦截器 LogInterceptor.java

用途：每一次链路，线程维度，添加最终的链路ID traceId。

MDC(Mapped Diagnostic Context)诊断上下文映射，是@Slf4j提供的一个支持动态打印日志信息的工具。

  1. import org.slf4j.MDC;
  2. import org.springframework.lang.Nullable;
  3. import org.springframework.util.StringUtils;
  4. import org.springframework.web.servlet.HandlerInterceptor;
  5.  
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  8. import java.util.UUID;
  9.  
  10. /**
  11.  * 日志拦截器
  12.  */
  13. public class LogInterceptor implements HandlerInterceptor {
  14.  
  15.     private static final String traceId = "traceId";
  16.  
  17.     @Override
  18.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
  19.         String tid = UUID.randomUUID().toString().replace("-", "");
  20.         //可以考虑让客户端传入链路ID，但需保证一定的复杂度唯一性；如果没使用默认UUID自动生成
  21.         if (!StringUtils.isEmpty(request.getHeader("traceId"))){
  22.             tid=request.getHeader("traceId");
  23.         }
  24.         MDC.put(traceId, tid);
  25.         return true;
  26.     }
  27.  
  28.     @Override
  29.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
  30.                                 @Nullable Exception ex) {
  31.         // 请求处理完成后,清除MDC中的traceId,以免造成内存泄漏
  32.         MDC.remove(traceId);
  33.     }
  34.  
  35. }

5、WebConfigurerAdapter.java 添加拦截器

ps: 其实这个拦截的部分改为使用自定义注解+aop也是很灵活的。

  1. import javax.annotation.Resource;
  2. import org.springframework.context.annotation.Configuration;
  3. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  4. import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
  5.  
  7. @Configuration
  8. public class WebConfigurerAdapter extends WebMvcConfigurationSupport {
  9.     @Resource
  10.     private LogInterceptor logInterceptor;
  12.     @Override
  13.     public void addInterceptors(InterceptorRegistry registry) {
  14.         registry.addInterceptor(logInterceptor);
  15.         //可以具体制定哪些需要拦截，哪些不拦截，其实也可以使用自定义注解更灵活完成
  16. //                .addPathPatterns("/**")
  17. //                .excludePathPatterns("/testxx.html");
  18.     }
  19. }

6、测试接口

  1. import io.swagger.annotations.Api;
  2. import io.swagger.annotations.ApiOperation;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RequestMethod;
  6. import org.springframework.web.bind.annotation.RestController;
  8. import javax.annotation.Resource;
  10. @RestController
  11. @Api(tags = "测试接口")
  12. @RequestMapping("/test")
  13. @Slf4j
  14. public class TestController {
  16.     @RequestMapping(value = "/log", method = RequestMethod.GET)
  17.     @ApiOperation(value = "测试日志")
  18.     public String sign() {
  19.         log.info("这是一行info日志");
  20.         log.error("这是一行error日志");
  21.         return "success";
  22.     }
  23. }

结果：

异步场景：

  1.     使用线程的场景，写一个异步线程，加入这个调用里面。再次执行看开效果，我们会发现显然子线程丢失了trackId。
  3.     所以我们需要针对子线程使用情形，做调整，思路：将父线程的trackId传递下去给子线程即可。

1、 ThreadMdcUtil.java

  1. import org.slf4j.MDC;
  2.  
  3. import java.util.Map;
  4. import java.util.UUID;
  5. import java.util.concurrent.Callable;
  6.  
  7. /**
  8.  * @Author: JCccc
  9.  * @Date: 2022-5-30 11:14
  10.  * @Description:
  11.  */
  12. public final class ThreadMdcUtil {
  13.     private static final String traceId = "traceId";
  14.  
  15.     // 获取唯一性标识
  16.     public static String generateTraceId() {
  17.         return UUID.randomUUID().toString().replace("-", "");
  18.     }
  19.  
  20.     public static void setTraceIdIfAbsent() {
  21.         if (MDC.get(traceId) == null) {
  22.             MDC.put(traceId, generateTraceId());
  23.         }
  24.     }
  25.  
  26.     /**
  27.      * 用于父线程向线程池中提交任务时，将自身MDC中的数据复制给子线程
  28.      *
  29.      * @param callable
  30.      * @param context
  31.      * @param <T>
  32.      * @return
  33.      */
  34.     public static <T> Callable<T> wrap(final Callable<T> callable, final Map<String, String> context) {
  35.         return () -> {
  36.             if (context == null) {
  37.                 MDC.clear();
  38.             } else {
  39.                 MDC.setContextMap(context);
  40.             }
  41.             setTraceIdIfAbsent();
  42.             try {
  43.                 return callable.call();
  44.             } finally {
  45.                 MDC.clear();
  46.             }
  47.         };
  48.     }
  49.  
  50.     /**
  51.      * 用于父线程向线程池中提交任务时，将自身MDC中的数据复制给子线程
  52.      *
  53.      * @param runnable
  54.      * @param context
  55.      * @return
  56.      */
  57.     public static Runnable wrap(final Runnable runnable, final Map<String, String> context) {
  58.         return () -> {
  59.             if (context == null) {
  60.                 MDC.clear();
  61.             } else {
  62.                 MDC.setContextMap(context);
  63.             }
  64.             setTraceIdIfAbsent();
  65.             try {
  66.                 runnable.run();
  67.             } finally {
  68.                 MDC.clear();
  69.             }
  70.         };
  71.     }
  72. }

2、 MyThreadPoolTaskExecutor.java 是我们自己写的，重写了一些方法

  1. import org.slf4j.MDC;
  2. import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
  3.  
  4. import java.util.concurrent.Callable;
  5. import java.util.concurrent.Future;
  6.  
  8. public final class MyThreadPoolTaskExecutor  extends ThreadPoolTaskExecutor  {
  9.     public MyThreadPoolTaskExecutor() {
  10.         super();
  11.     }
  12.     
  13.     @Override
  14.     public void execute(Runnable task) {
  15.         super.execute(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
  16.     }
  17.  
  18.  
  19.     @Override
  20.     public <T> Future<T> submit(Callable<T> task) {
  21.         return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
  22.     }
  23.  
  24.     @Override
  25.     public Future<?> submit(Runnable task) {
  26.         return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
  27.     }
  28. }

3、 ThreadPoolConfig.java 定义线程池，交给spring管理

  1. import org.springframework.context.annotation.Bean;
  2. import org.springframework.context.annotation.Configuration;
  3. import org.springframework.scheduling.annotation.EnableAsync;
  5. import java.util.concurrent.Executor;
  7. @EnableAsync
  8. @Configuration
  9. public class ThreadPoolConfig {
  10.     /**
  11.      * 声明一个线程池
  12.      */
  13.     @Bean("taskExecutor")
  14.     public Executor taskExecutor() {
  15.         MyThreadPoolTaskExecutor executor = new MyThreadPoolTaskExecutor();
  16.         //核心线程数5：线程池创建时候初始化的线程数
  17.         executor.setCorePoolSize(5);
  18.         //最大线程数5：线程池最大的线程数，只有在缓冲队列满了之后才会申请超过核心线程数的线程
  19.         executor.setMaxPoolSize(5);
  20.         //缓冲队列500：用来缓冲执行任务的队列
  21.         executor.setQueueCapacity(500);
  22.         //允许线程的空闲时间60秒：当超过了核心线程出之外的线程在空闲时间到达之后会被销毁
  23.         executor.setKeepAliveSeconds(60);
  24.         //线程池名的前缀：设置好了之后可以方便我们定位处理任务所在的线程池
  25.         executor.setThreadNamePrefix("taskExecutor-");
  26.         executor.initialize();
  27.         return executor;
  28.     }
  29. }

4、 Service

  1. import lombok.extern.slf4j.Slf4j;
  2. import org.springframework.scheduling.annotation.Async;
  3. import org.springframework.stereotype.Service;
  5. /**
  6.  * 测试Service
  7.  */
  8. @Service("testService")
  9. @Slf4j
  10. public class TestService {
  12.     /**
  13.      * 异步操作测试
  14.      */
  15.     @Async("taskExecutor")
  16.     public void asyncTest() {
  17.         try {
  18.             log.info("模拟异步开始......");
  19.             Thread.sleep(3000);
  20.             log.info("模拟异步结束......");
  21.         } catch (InterruptedException e) {
  22.             log.error("异步操作出错:"+e);
  23.         }
  24.         
  25.     }
  27. }

5、测试接口

  1. import io.swagger.annotations.Api;
  2. import io.swagger.annotations.ApiOperation;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RequestMethod;
  6. import org.springframework.web.bind.annotation.RestController;
  8. import javax.annotation.Resource;
  10. @RestController
  11. @Api(tags = "测试接口")
  12. @RequestMapping("/test")
  13. @Slf4j
  14. public class TestController {
  16.     @Resource
  17.     private TestService testService;
  19.     @RequestMapping(value = "/log", method = RequestMethod.GET)
  20.     @ApiOperation(value = "测试日志")
  21.     public String sign() {
  22.         log.info("这是一行info日志");
  23.         log.error("这是一行error日志");
  25.         //异步操作测试
  26.         testService.asyncTest();
  27.         return "success";
  28.     }
  29. }

结果：

我们可以看到，子线程的日志也被串起来了。

定时任务：

如果使用了定时任务@Scheduled，这时候执行定时任务，不会走上面的拦截器逻辑，所以定时任务需要单独创建个AOP切面。

1、创建个定时任务线程池

  1. import org.springframework.context.annotation.Configuration;
  2. import org.springframework.scheduling.annotation.EnableScheduling;
  3. import org.springframework.scheduling.annotation.SchedulingConfigurer;
  4. import org.springframework.scheduling.config.ScheduledTaskRegistrar;
  6. import java.util.concurrent.Executors;
  8. /**
  9.  * 定时任务线程池
  10.  */
  11. @EnableScheduling
  12. @Configuration
  13. public class SeheduleConfig implements SchedulingConfigurer{
  14.     @Override
  15.     public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
  16.         taskRegistrar.setScheduler(Executors.newScheduledThreadPool(5));
  17.     }
  18. }

2、创建个AOP切面

  1. import org.aspectj.lang.ProceedingJoinPoint;
  2. import org.aspectj.lang.annotation.Around;
  3. import org.aspectj.lang.annotation.Aspect;
  4. import org.aspectj.lang.annotation.Pointcut;
  5. import org.slf4j.MDC;
  6. import org.springframework.context.annotation.Configuration;
  8. import java.util.UUID;
  10. @Aspect   //定义一个切面
  11. @Configuration
  12. public class SeheduleTaskAspect {
  14.     // 定义定时任务切点Pointcut
  15.     @Pointcut("@annotation(org.springframework.scheduling.annotation.Scheduled)")
  16.     public void seheduleTask() {
  17.     }
  19.     @Around("seheduleTask()")
  20.     public void doAround(ProceedingJoinPoint joinPoint) throws Throwable {
  21.         try {
  22.             String traceId = UUID.randomUUID().toString().replace("-", "");
  23.             //用于日志链路追踪，logback配置:%X{traceId}
  24.             MDC.put("traceId", traceId);
  25.             //执行定时任务方法
  26.             joinPoint.proceed();
  27.         } finally {
  28.             //请求处理完成后，清除MDC中的traceId，以免造成内存泄漏
  29.             MDC.remove("traceId");
  30.         }
  31.     }
  33. }

3、创建定时任务测试

  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. import org.springframework.scheduling.annotation.Scheduled;
  4. import org.springframework.stereotype.Service;
  6. import java.util.Date;
  8. @Service
  9. public class SeheduleTasks {
  11.     private Logger logger = LoggerFactory.getLogger(SeheduleTasks.class);
  13.     /**
  14.      * 1分钟执行一次
  15.      */
  16.     @Scheduled(cron = "0 0/1 * * * ?")
  17.     public void testTask() {
  18.         logger.info("执行定时任务>"+new Date());
  19.     }
  21. }

总结：

服务启动的时候traceId是空的，这是正常的，因为还没到拦截器这一层。

源码：https://download.csdn.net/download/u011974797/89981672

API 说明
  • clear() => 移除所有 MDC
  • get (String key) => 获取当前线程 MDC 中指定 key 的值
  • getContext() => 获取当前线程 MDC 的 MDC
  • put(String key, Object o) => 往当前线程的 MDC 中存入指定的键值对
  • remove(String key) => 删除当前线程 MDC 中指定的键值对
标签： spring traceId 日志链路
本文转载自: https://blog.csdn.net/u011974797/article/details/143682368
版权归原作者 涛哥是个大帅比 所有， 如有侵权，请联系我们删除。
登录后发布评论

“SpringBoot使用TraceId日志链路追踪”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

网络安全法-网络运行安全

使用selenium/drissionpage时如何阻止chrome自动跳转http到https

docker desktop 里部署的Open WebUI 管理员密码忘记了的处理方法

在ubuntu20.04中搭建onsite比赛运行环境

利用开源的低代码表单设计器FcDesigner高效管理和渲染复杂表单结构

Kafka学习笔记

【前端】浏览器输入url到页面呈现发生了什么？