本文为博主原创,未经允许不得转载:
在开发过程中,经常会使用log记录一下当前请求的参数,过程和结果,以便帮助定位问题。在并发量下的情况下,日志打印不会剧增,可以很快就能通过打印的日志查看执行的情况。但是在高并发大量请求的场景下,日志也会频繁打印,刷新,通过查看日志来定位问题时就会变得很难,因为无法确定打印的日志是哪一条请求时打印的,从而影响问题的定位速度。
一种轻量级的实现,通过 MDC 机制,将请求的 trace-id 放入到MDC中,在日志打印时,通过 MDC 中的 trace-id 将同一个请求的每一条日志串联起来。因为 MDC 是线程隔离且安全的。
logback MDC 实现日志追踪实现:
1. 在请求刚到达网关层时,添加一个过滤器,每个请求在过滤器时,在 logback 的MDC 中放入 trace-id。
import com.baomidou.mybatisplus.core.toolkit.IdWorker; import org.slf4j.MDC; import javax.servlet.*; import java.io.IOException; public class LogFilter implements Filter { @Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { // 使用雪花算法生成一个请求Id String traceId = Long.toString(IdWorker.getId()); MDC.put("trace-id",traceId); } }
2. 在logback.xml 中配置 log 打印格式,并打印 trace-id
<!-- 控制台输出 --> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder charset="UTF-8"> <!-- 输出日志记录格式,并打印 trace-id --> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%trace-id] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender>
logback 中也可以使用占位符%X{ }来占位,替换到对应的 MDC 中 key 的值
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <layout> <Pattern>%X{trace-id}- %m%n</Pattern> </layout> </appender>
3. logback mdc实现原理
logback的实现类LogbackMDCAdapter利用的ThreadLocal技术保证了每个请求线程保有自己的MDC环境变量。其使用了装饰者模式。
MDCAdapter有三个实现类,BasicMDCAdapter、LogbackMDCAdapter,NOPMDCAdapter。Logback使用的是LogbackMDCAdapter。
LogbackMDCAdapter 中使用的时 ThreadLocal 进行线程隔离实现的。
附:在日志打印优化以及方便日志定位的过程中,也可以使用 AOP,对 controller ,service 等进行统一打印,打印每一个方法的调用请求参数,开始时间,结束时间,耗时等。这会大大提高日志的价值。
标签: java