脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → MDC实现日志链路跟踪

使用MDC实现日志链路跟踪

 更新时间：2022年01月17日 09:25:56   作者：lakernote   
这篇文章主要介绍了使用MDC实现日志链路跟踪，在微服务环境中，我们经常使用Skywalking、CAT等去实现整体请求链路的追踪，但是这个整体运维成本高，架构复杂，我们来使用MDC通过Log来实现一个轻量级的会话事务跟踪功能,下面就来看看具体的过程吧,需要的朋友可以参考一下

前言:

在微服务环境中，我们经常使用Skywalking、CAT等去实现整体请求链路的追踪，但是这个整体运维成本高，架构复杂，我们来使用MDC通过Log来实现一个轻量级的会话事务跟踪功能。

1.原理

MDC org.sl4j.MDC其实内部就是ThreadLocal，MDC提供了put/get/clear等几个核心接口，用于操作ThreadLocal中的数据；ThreadLocal中的K-V，可以在logback.xml中声明，最终将会打印在日志中。

// java代码
MDC.put("userId","laker");  

// logback.xml
%X{userId}

例如：

<property name="pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level [%X{userId}] %logger{20} - %msg%n"/>

2.实现

整体流程如下：

  • 用户登录系统，我们日志中记录userId:laker。
  • 用户发起请求，一个请求中可能实际产生多个http请求，这里可以前端生成一个requestId
  • 在返回体中，返回requestId。
  • 研发运维人员，可以根据 userId和requestId去日志中捞请求链路。

3.过滤器

@Order(value = Ordered.HIGHEST_PRECEDENCE + 100)
@Component
@WebFilter(filterName = "MDCFilter", urlPatterns = "/*")
public class MDCFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
        try {
            MDC.put("userId", "laker");
            MDC.put("requestId", IdUtil.fastUUID());
        } catch (Exception e) {
            //
        }

        try {
            filterChain.doFilter(httpServletRequest, httpServletResponse);
        } finally {
            MDC.clear();
        }
    }
}

4.logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="LOG_HOME" value="logs"/>
    <property name="encoding" value="UTF-8"/>

    <appender name="DEFAULT" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_HOME}/test.log</file>
        <Append>true</Append>
        <prudent>false</prudent>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{50} %line - %m%n</pattern>
        </encoder>
        <!-- 按天回滚 daily -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--归档日志文件名-->
            <FileNamePattern>${LOG_HOME}/test.log.%d{yyyy-MM-dd}</FileNamePattern>
            <!-- 最多保存15天历史文件 -->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
    </appender>

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

    <!-- 控制台输出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{50} %line - %m%n</pattern>
        </encoder>
    </appender>

    <logger name="com.test.demo" level="DEBUG">
        <appender-ref ref="DEFAULT"/>
    </logger>
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="DEFAULT"/>
        <appender-ref ref="console"/>
    </root>
</configuration>

5.返回体

public class Response<T> {
    @ApiModelProperty(notes = "响应码，非200 即为异常", example = "200")
    private final int code;
    @ApiModelProperty(notes = "响应消息", example = "提交成功")
    private final String msg;
    @ApiModelProperty(notes = "响应数据")
    private final T data;
    @ApiModelProperty(notes = "请求id")
    private final String requestId;

    public Response(int code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
        this.requestId = MDC.get("requestId");
    }

6.效果日志

响应:

{
    code: 200,
    msg: "",
    requestId: "74a269a8-3cb4-417e-853c-b968b77cce23"
}

日志:

18:37:15.997 [http-nio-8080-exec-1] INFO  [laker|90717490-5ef4-4e46-bc2c-605952fc3803] c.l.m.c.InfoController - [v2Map,17] - null
18:37:38.980 [http-nio-8080-exec-2] INFO  [laker|82bde351-f86e-466f-97a0-c857a0c4c1c9] c.l.m.c.InfoController - [v2Map,17] - null
18:37:39.992 [http-nio-8080-exec-3] INFO  [laker|74a269a8-3cb4-417e-853c-b968b77cce23] c.l.m

到此这篇关于使用MDC实现日志链路跟踪的文章就介绍到这了,更多相关MDC实现日志链路跟踪内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • springboot项目之相互依赖报错问题(基于idea)

    springboot项目之相互依赖报错问题(基于idea)

    这篇文章主要介绍了springboot项目之相互依赖报错问题(基于idea)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-02-02
  • springmvc实现简单的拦截器

    springmvc实现简单的拦截器

    这篇文章主要为大家详细介绍了springmvc实现简单拦截器的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-05-05
  • java实现一个桌球小游戏

    java实现一个桌球小游戏

    这篇文章主要为大家详细介绍了java实现一个桌球小游戏，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-07-07
  • 简单了解Java创建线程两种方法

    简单了解Java创建线程两种方法

    这篇文章主要介绍了简单了解Java创建线程两种方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • Java中ThreadLocal线程变量的实现原理

    Java中ThreadLocal线程变量的实现原理

    本文主要介绍了Java中ThreadLocal线程变量的实现原理，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • JAVA-4NIO之Channel之间的数据传输方法

    JAVA-4NIO之Channel之间的数据传输方法

    下面小编就为大家带来一篇JAVA-4NIO之Channel之间的数据传输方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • java实现打字游戏小程序

    java实现打字游戏小程序

    这篇文章主要为大家详细介绍了java实现打字游戏小程序，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2020-10-10
  • 快速理解spring中的各种注解

    快速理解spring中的各种注解

    这篇文章主要介绍了快速理解spring中的各种注解，具有一定借鉴价值，需要的朋友可以了解下。
    2017-12-12
  • 关于Java中代码块的执行顺序

    关于Java中代码块的执行顺序

    这篇文章主要介绍了关于Java中代码块的执行顺序,构造代码块是给所有对象进行统一初始化,而构造函数是给对应的对象初始化,因为构造函数是可以多个的,运行哪个构造函数就会建立什么样的对象,但无论建立哪个对象,都会先执行相同的构造代码块,需要的朋友可以参考下
    2023-08-08
  • Java实现生成自定义时长的静音音频

    Java实现生成自定义时长的静音音频

    这篇文章主要介绍了如何通过Java实现一个音频工具类，可以实现生成一段自定义时长(精确到毫秒)的wav音频。感兴趣的小伙伴可以了解一下
    2022-01-01

最新评论