从零搭建开发脚手架 使用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> 
  
            <!-- 数最多储存半个月历史时间文档 --> 
  
            <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