使用MDC實(shí)現(xiàn)日志鏈路跟蹤

更新時(shí)間：2022年01月17日 09:25:56 作者：lakernote?

這篇文章主要介紹了使用MDC實(shí)現(xiàn)日志鏈路跟蹤，在微服務(wù)環(huán)境中，我們經(jīng)常使用Skywalking、CAT等去實(shí)現(xiàn)整體請(qǐng)求鏈路的追蹤，但是這個(gè)整體運(yùn)維成本高，架構(gòu)復(fù)雜，我們來(lái)使用MDC通過(guò)Log來(lái)實(shí)現(xiàn)一個(gè)輕量級(jí)的會(huì)話事務(wù)跟蹤功能,下面就來(lái)看看具體的過(guò)程吧,需要的朋友可以參考一下

在微服務(wù)環(huán)境中，我們經(jīng)常使用Skywalking、CAT等去實(shí)現(xiàn)整體請(qǐng)求鏈路的追蹤，但是這個(gè)整體運(yùn)維成本高，架構(gòu)復(fù)雜，我們來(lái)使用MDC通過(guò)Log來(lái)實(shí)現(xiàn)一個(gè)輕量級(jí)的會(huì)話事務(wù)跟蹤功能。

1.原理

MDC org.sl4j.MDC其實(shí)內(nèi)部就是ThreadLocal，MDC提供了put/get/clear等幾個(gè)核心接口，用于操作ThreadLocal中的數(shù)據(jù)；ThreadLocal中的K-V，可以在logback.xml中聲明，最終將會(huì)打印在日志中。

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

2.實(shí)現(xiàn)

整體流程如下：

用戶登錄系統(tǒng)，我們?nèi)罩局杏涗?code>userId:laker。
用戶發(fā)起請(qǐng)求，一個(gè)請(qǐng)求中可能實(shí)際產(chǎn)生多個(gè)http請(qǐng)求，這里可以前端生成一個(gè)requestId
在返回體中，返回requestId。
研發(fā)運(yùn)維人員，可以根據(jù) userId和requestId去日志中撈請(qǐng)求鏈路。

3.過(guò)濾器

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

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

? ? <!-- 控制臺(tái)輸出 -->
? ? <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>
? ? <!-- 日志輸出級(jí)別 -->
? ? <root level="INFO">
? ? ? ? <appender-ref ref="DEFAULT"/>
? ? ? ? <appender-ref ref="console"/>
? ? </root>
</configuration>

5.返回體

public class Response<T> {
? ? @ApiModelProperty(notes = "響應(yīng)碼，非200 即為異常", example = "200")
? ? private final int code;
? ? @ApiModelProperty(notes = "響應(yīng)消息", example = "提交成功")
? ? private final String msg;
? ? @ApiModelProperty(notes = "響應(yīng)數(shù)據(jù)")
? ? private final T data;
? ? @ApiModelProperty(notes = "請(qǐng)求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");
? ? }

6.效果日志

響應(yīng):

{
?? ?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

到此這篇關(guān)于使用MDC實(shí)現(xiàn)日志鏈路跟蹤的文章就介紹到這了,更多相關(guān)MDC實(shí)現(xiàn)日志鏈路跟蹤內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: