社区编辑申请
注册/登录
从零搭建开发脚手架 使用MDC实现日志链路跟踪
开发 架构
在微服务环境中,我们经常使用Skywalking、CAT等去实现整体请求链路的追踪,但是这个整体运维成本高,架构复杂,我们来使用MDC通过Log来实现一个轻量级的会话事务跟踪功能。
本文转载自微信公众号「Java大厂面试官」,作者laker。转载本文请联系Java大厂面试官公众号。
  • 前言
  • 原理
  • 实现
    • 过滤器
    • logback.xml
    • 返回体
  • 效果日志

前言

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

原理

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

  1. // java代码 
  2. MDC.put("userId","laker");   
  3.  
  4. // logback.xml 
  5. %X{userId} 

例如:

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

实现

整体流程如下:

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

过滤器

  1. @Order(value = Ordered.HIGHEST_PRECEDENCE + 100) 
  2. @Component 
  3. @WebFilter(filterName = "MDCFilter", urlPatterns = "/*"
  4. public class MDCFilter extends OncePerRequestFilter { 
  5.  
  6.     @Override 
  7.     protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException { 
  8.         try { 
  9.             MDC.put("userId""laker"); 
  10.             MDC.put("requestId", IdUtil.fastUUID()); 
  11.         } catch (Exception e) { 
  12.             // 
  13.         } 
  14.  
  15.         try { 
  16.             filterChain.doFilter(httpServletRequest, httpServletResponse); 
  17.         } finally { 
  18.             MDC.clear(); 
  19.         } 
  20.     } 

logback.xml

  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <configuration> 
  3.     <property name="LOG_HOME" value="logs"/> 
  4.     <property name="encoding" value="UTF-8"/> 
  5.  
  6.     <appender name="DEFAULT" class="ch.qos.logback.core.rolling.RollingFileAppender"
  7.         <file>${LOG_HOME}/test.log</file> 
  8.         <Append>true</Append> 
  9.         <prudent>false</prudent> 
  10.         <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"
  11.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{50} %line - %m%n</pattern> 
  12.         </encoder> 
  13.         <!-- 按天回滚 daily --> 
  14.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"
  15.             <!--归档日志文件名--> 
  16.             <FileNamePattern>${LOG_HOME}/test.log.%d{yyyy-MM-dd}</FileNamePattern> 
  17.             <!-- 最多保存15天历史文件 --> 
  18.             <maxHistory>15</maxHistory> 
  19.         </rollingPolicy> 
  20.     </appender> 
  21.  
  22.     <!-- 日志输出格式 --> 
  23.     <property name="log.pattern" 
  24.               value="%d{HH:mm:ss.SSS} [%thread] %-5level [%X{userId}|%X{requestId}] %logger{20} - [%method,%line] - %msg%n"/> 
  25.  
  26.     <!-- 控制台输出 --> 
  27.     <appender name="console" class="ch.qos.logback.core.ConsoleAppender"
  28.         <encoder> 
  29.             <pattern>${log.pattern}</pattern> 
  30.         </encoder> 
  31.     </appender> 
  32.  
  33.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"
  34.         <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"
  35.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{50} %line - %m%n</pattern> 
  36.         </encoder> 
  37.     </appender> 
  38.  
  39.     <logger name="com.test.demo" level="DEBUG"
  40.         <appender-ref ref="DEFAULT"/> 
  41.     </logger> 
  42.     <!-- 日志输出级别 --> 
  43.     <root level="INFO"
  44.         <appender-ref ref="DEFAULT"/> 
  45.         <appender-ref ref="console"/> 
  46.     </root> 
  47. </configuration> 

返回体

  1. public class Response<T> { 
  2.     @ApiModelProperty(notes = "响应码,非200 即为异常", example = "200"
  3.     private final int code; 
  4.     @ApiModelProperty(notes = "响应消息", example = "提交成功"
  5.     private final String msg; 
  6.     @ApiModelProperty(notes = "响应数据"
  7.     private final T data; 
  8.     @ApiModelProperty(notes = "请求id"
  9.     private final String requestId; 
  10.  
  11.     public Response(int code, String msg, T data) { 
  12.         this.code = code; 
  13.         this.msg = msg; 
  14.         this.data = data; 
  15.         this.requestId = MDC.get("requestId"); 
  16.     } 

效果日志

响应

  1.  code: 200, 
  2.  msg: ""
  3.  requestId: "74a269a8-3cb4-417e-853c-b968b77cce23" 

日志

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

 

责任编辑:武晓燕 来源: Java大厂面试官

同话题下的热门内容

微服务架构的可观察性设计模式汽车之家APP基于Mach-O的探索与实践六张图告诉你 RocketMQ 是怎么保存偏移量的Dubbo 高性能 RPC 框架实践如何使用 Sentinel 保护您的微服务微服务架构的服务发现设计模式Hadoop中的契约监控机制,被惊艳到了聊聊客户档案模型的设计与管理

编辑推荐

终于有人把Elasticsearch原理讲透了!花了一个星期,我终于把RPC框架整明白了!拜托!面试不要再问我Spring Cloud底层原理陌陌基于K8s和Docker容器管理平台的架构实践收藏 | 第一次有人把“分布式事务”讲的这么简单明了
我收藏的内容
点赞
收藏

51CTO技术栈公众号