基于Slf4j MDC和Spring MVC的日志链路跟踪

  • 背景

1.在日常查日志时,各种日志交错在一起,无法快速定位问题,如果有每个请求都拥有一个唯一标识,那grep起来就方便多了;

2.分布式系统中需要定位整个链路,是上游系统出问题了,或者下游系统有没有收到请求;

  • 方案

Slf4j是我们常用的日志门面,它服务于Logback和log4j等日志框架,其中有一个重要特性是MDC(Mapped Diagnostic Contexts );

顾名思义,其目的是为了便于我们诊断线上问题而出现的方法工具类,使用ThreadLocal思想在线程上下文中维护变量;

比如配置文件logback.xml 中配置了%X{key},则后台日志打印出对应的 key 的值;

文档地址:https://logback.qos.ch/manual/mdc.html

  • 应用

1.通过日志配置文件加traceId变量(%X{traceId})
如:${APP_NAME}: %d{yyyy-MM-dd HH:mm:ss.SSS} [%X{traceId}] [%thread] %p - %c %m%n

2.定义Filter(也可以用Spring MVC的拦截器),这里提供下关键方法doFilter:
doFilter
注:在进去请求前使用MDC.put将traceId放入线程变量,最后finally删除变量,这里traceId生成算法采用UUID,还有比如线程名+时间戳方式,实用就行。

3.在web.xml中声明Filter
声明Filter
4.结果展示
示例:Controller里调用了Service1的doSomething方法,而Service1又分别调用了Service2和Service3的doSomething方法,那么形式的日志如下:
结果展示
所以通过grep 45c5827048ab4d61a81eed0caff35dce就可以定位整个调用过程

5.应用于分布式系统
包装上游系统的请求,将traceId放入header中,并在下游系统定义Filter解析header,然后使用MDC工具类将traceId放入线程变量。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章