从零搭建开发脚手架 使用MDC实现日志链路跟踪

[[399330]]
本文转载自微信公众号「Java大厂面试官」,作者laker。转载本文请联系Java大厂面试官公众号。

成都创新互联是一家专业提供罗湖企业网站建设,专注与网站建设、成都网站建设、H5开发、小程序制作等业务。10年已为罗湖众多企业、政府机构等服务。创新互联专业网站设计公司优惠进行中。

  • 前言
  • 原理
  • 实现
    • 过滤器
    • 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.  

实现

整体流程如下:

  • 用户登录系统,我们日志中记录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.  
  2.  
  3.      
  4.      
  5.  
  6.      
  7.         ${LOG_HOME}/test.log 
  8.         true 
  9.         false 
  10.          
  11.             %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{50} %line - %m%n 
  12.          
  13.          
  14.          
  15.              
  16.             ${LOG_HOME}/test.log.%d{yyyy-MM-dd} 
  17.              
  18.             15 
  19.          
  20.      
  21.  
  22.      
  23.     
  24.               value="%d{HH:mm:ss.SSS} [%thread] %-5level [%X{userId}|%X{requestId}] %logger{20} - [%method,%line] - %msg%n"/> 
  25.  
  26.      
  27.      
  28.          
  29.             ${log.pattern} 
  30.          
  31.      
  32.  
  33.      
  34.          
  35.             %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{50} %line - %m%n 
  36.          
  37.      
  38.  
  39.      
  40.          
  41.      
  42.      
  43.      
  44.          
  45.          
  46.      
  47.  

返回体

 
 
 
  1. public class Response { 
  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 

分享文章:从零搭建开发脚手架 使用MDC实现日志链路跟踪
URL标题:http://www.mswzjz.cn/qtweb/news21/91371.html

攀枝花网站建设、攀枝花网站运维推广公司-贝锐智能,是专注品牌与效果的网络营销公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 贝锐智能