如何使用MDC實現日志鏈路跟蹤

本篇內容介紹了“如何使用MDC實現日志鏈路跟蹤”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

• 前言

• 原理

• 實現

• 過濾器

• logback.xml

• 返回體

• 效果日志

前言

在微服務環境中，我們經常使用Skywalking、CAT等去實現整體請求鏈路的追蹤，但是這個整體運維成本高，架構復雜，我們來使用MDC通過Log來實現一個輕量級的會話事務跟蹤功能。

原理

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"/>

實現

整體流程如下：

• 用戶登錄系統，我們日志中記錄userId:laker。

• 用戶發起請求，一個請求中可能實際產生多個http請求，這里可以前端生成一個requestId

• 在返回體中，返回requestId。

• 研發運維人員，可以根據 userId和requestId去日志中撈請求鏈路。

過濾器

@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();         }     } }

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>

返回體

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");     }

效果日志

響應

{  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.c.InfoController - [v2Map,17] - null

“如何使用MDC實現日志鏈路跟蹤”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！