SpringBoot MDC全链路调用日志跟踪实现详解

 更新时间:2023年02月08日 09:31:23   作者:IT小马哥  
这篇文章主要为大家介绍了SpringBoot MDC全链路调用日志跟踪实现详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

MDC 介绍

MDC(Mapped Diagnostic Context,映射调试上下文)是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时,只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说,通常是在请求被处理的最开始保存这些数据。

API 说明

  • clear() => 移除所有 MDC
  • get (String key) => 获取当前线程 MDC 中指定 key 的值
  • getContext() => 获取当前线程 MDC 的 MDC
  • put(String key, Object o) => 往当前线程的 MDC 中存入指定的键值对
  • remove(String key) => 删除当前线程 MDC 中指定的键值对

MDC 使用

Constants.TRACE_ID = "traceId"

添加拦截器

public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果有上层调用就用上层的ID
        String traceId = request.getHeader(Constants.TRACE_ID);
        if (traceId == null) {
            traceId = TraceIdUtil.getTraceId();
        }
        MDC.put(Constants.TRACE_ID, traceId);
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        //调用结束后删除
        MDC.remove(Constants.TRACE_ID);
    }
}

修改日志格式

<!-- 日志输出格式 -->
<property name="log.pattern" value="[TraceId:%X{traceId}] %d{HH🇲🇲ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>

重点是 %X{traceId},traceId 和 MDC 中的键名称一致。

简单使用就这么容易,但是在有些情况下 traceId 将获取不到。

常见问题

子线程日志打印丢失 traceId

   //获取traceId
   Map<String, String> mdcContextMap = MDC.getCopyOfContextMap();
   return  () ->{
     //添加到子线程中
     MDC.setContextMap(mdcContextMap);
     System.out.println("你好呀!");
   }       

以上就是SpringBoot MDC全链路调用日志跟踪实现详解的详细内容,更多关于SpringBoot MDC日志跟踪的资料请关注脚本之家其它相关文章!

相关文章

  • Spring boot启动原理及相关组件整理

    Spring boot启动原理及相关组件整理

    这篇文章主要介绍了Spring boot启动原理及相关组件整理,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧
    2024-12-12
  • IDEA感觉不香了AI智能编程工具Cursor使用图文教程

    IDEA感觉不香了AI智能编程工具Cursor使用图文教程

    这篇文章主要介绍了IDEA感觉不香了AI智能编程工具Cursor使用,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-05-05
  • Java基础入门之switch怎么使用枚举

    Java基础入门之switch怎么使用枚举

    在Java开发中,switch语句是一种常用的流控制语句,而当使用枚举类型作为条件时,我们常常会遇到报错问题,那么该如何解决呢,下面就来详细讲讲
    2023-06-06
  • Java利用JSch实现SSH远程操作的技术指南

    Java利用JSch实现SSH远程操作的技术指南

    在日常开发中,许多应用需要通过 SSH 协议远程连接服务器来执行命令、上传或下载文件,JSch是一个功能强大的 Java 库,它提供了便捷的接口来实现 SSH 连接和其他远程管理功能,本文将介绍 JSch 的基本功能,并通过实际代码示例帮助您快速上手,需要的朋友可以参考下
    2025-03-03
  • Java并发编程:CountDownLatch与CyclicBarrier和Semaphore的实例详解

    Java并发编程:CountDownLatch与CyclicBarrier和Semaphore的实例详解

    这篇文章主要介绍了Java并发编程:CountDownLatch与CyclicBarrier和Semaphore的实例详解的相关资料,需要的朋友可以参考下
    2017-09-09
  • 使用spring容器在初始化Bean时前和后的操作

    使用spring容器在初始化Bean时前和后的操作

    这篇文章主要介绍了使用spring容器在初始化Bean时前和后的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Java POI库从入门到精通举例详解

    Java POI库从入门到精通举例详解

    Apache POI是一个开源项目,能够让Java程序员读取和写入Microsoft Office格式的文件,包括Excel、Word和PowerPoint等,本文详细介绍了POI库的安装、结构与功能,以及如何在Java中进行基本操作和进阶应用,需要的朋友可以参考下
    2024-10-10
  • java ImmutableMap的使用说明

    java ImmutableMap的使用说明

    这篇文章主要介绍了java ImmutableMap的使用说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • 如何用Spring发送电子邮件

    如何用Spring发送电子邮件

    这篇文章主要介绍了如何用Spring发送电子邮件,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2021-02-02
  • play for scala 实现SessionFilter 过滤未登录用户跳转到登录页面

    play for scala 实现SessionFilter 过滤未登录用户跳转到登录页面

    这篇文章主要介绍了play for scala 实现SessionFilter 过滤未登录用户跳转到登录页面的相关资料,需要的朋友可以参考下
    2016-11-11

最新评论