快捷導(dǎo)航

如何為Logback日志添加唯一追蹤ID

更新時(shí)間：2024年12月16日 09:56:43 作者：Mistra丶

本文介紹了如何為Logback日志添加唯一追蹤ID,以便在測(cè)試和調(diào)試時(shí)更容易定位報(bào)錯(cuò)信息,通過創(chuàng)建過濾器和修改配置文件,可以在每個(gè)請(qǐng)求的日志中添加唯一的ID,并將其返回給前端,這樣,當(dāng)用戶反饋報(bào)錯(cuò)時(shí),開發(fā)人員可以根據(jù)ID快速定位和解決問題

為Logback日志添加唯一追蹤ID

平常在測(cè)試的時(shí)候，不容易定位報(bào)錯(cuò)信息，這個(gè)時(shí)候給日志加上唯一的追蹤ID，查找日志的時(shí)候就非常方便了。

像這樣：

每個(gè)請(qǐng)求打印的日志都會(huì)有不同的ID，哪個(gè)請(qǐng)求出錯(cuò)，根據(jù)ID來定位日志就行了。

這個(gè)ID還會(huì)返回給前端，前端發(fā)現(xiàn)報(bào)錯(cuò)讓后臺(tái)找原因的話只需要給個(gè)ID，后臺(tái)開發(fā)人員就能根據(jù)

環(huán)境：

SpringBoot - 2.1.5.RELEASE
JDK8

一、創(chuàng)建過濾器

LogMDCFilter.java

public class LogMDCFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        String requestIdKey = "requestId";
        String requestId = UUID.randomUUID().toString();
        MDC.put(requestIdKey, requestId);

        String levelName = "logLevel";
        String value = servletRequest.getParameter(levelName);
        if (StringUtils.isNotBlank(value)) {
        	//org.slf4j.MDC
            MDC.put(levelName, value.toUpperCase());
        }

        try {
            filterChain.doFilter(servletRequest, servletResponse);
        } finally {
            MDC.remove(requestIdKey);
            MDC.remove(levelName);
        }
    }

    @Override
    public void destroy() {

    }
}

DebugLogTurboFilter.java

public class DebugLogTurboFilter extends TurboFilter {

    @Override
    public FilterReply decide(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) {
        int levelInt = level.toInt();
        String levelName = MDC.get("logLevel");
        if (StringUtils.isBlank(levelName) || "DEBUG,INFO,TRACE,WARN".indexOf(levelName) == -1) {
            return FilterReply.NEUTRAL;
        }
        if ((Level.TRACE.levelStr.equals(levelName) && levelInt >= Level.TRACE_INT)
                || (Level.DEBUG.levelStr.equals(levelName) && levelInt >= Level.DEBUG_INT)
                || (Level.INFO.levelStr.equals(levelName) && levelInt >= Level.INFO_INT)
                || (Level.WARN.levelStr.equals(levelName) && levelInt >= Level.WARN_INT)) {
            return FilterReply.ACCEPT;
        }
        return FilterReply.DENY;
    }
}

二、注冊(cè)過濾器

FilterConfiguration.java

@Configuration
public class FilterConfiguration {

    @Bean
    public FilterRegistrationBean logFilterRegistration() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        //注入過濾器
        registration.setFilter(new LogMDCFilter());
        //攔截規(guī)則
        registration.addUrlPatterns("/*");
        //過濾器名稱
        registration.setName("logMDCFilter");
        //過濾器順序
        registration.setOrder(0);
        return registration;
    }
}

三、Logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36}:%line - %msg %X{requestId}%n
            </pattern>
        </encoder>
    </appender>
	//上面的 DebugLogTurboFilter
    <turboFilter class="com.example.common.config.DebugLogTurboFilter">
    </turboFilter>

    <appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>/home/logs/merchant/common-merchant.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>/home/logs/merchant/history/merchant.%d{yyyy-MM-dd HH}.%i.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <maxFileSize>3MB</maxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36}:%line - %msg %X{requestId}%n
            </pattern>
        </encoder>
    </appender>

    <!-- project default level -->
    <logger name="com.version" level="DEBUG"/>
    <logger name="org.springframework.web.servlet.handler" level="INFO"/>
    <logger name="com.example.user.mapper" level="DEBUG"/>
    <!--log4jdbc -->
    <logger name="org.springframework.jdbc.core.JdbcTemplate" level="INFO"/>

    <root level="INFO">
        <appender-ref ref="console"/>
        <appender-ref ref="rollingFile"/>
    </root>
</configuration>

注意配置中的{requestId}占位符，這個(gè)就會(huì)替換為生成的唯一日志ID。

四、返回值封裝

ResponseModel.java

public class ResponseModel implements Serializable {

    private static final long serialVersionUID = -8972819161141262263L;

    @ApiModelProperty(value = "是否處理成功", name = "success", example = "true")
    private Boolean success;
    @ApiModelProperty(value = "返回碼", name = "code", example = "200")
    private Integer code;
    @ApiModelProperty(value = "處理消息", name = "msg", example = "處理成功")
    private String msg;
    @ApiModelProperty(value = "返回?cái)?shù)據(jù)", name = "data", example = "{}")
    private Object data;
    private String requestId = MDC.get("requestId");
    }

代碼寫完了，前端每次請(qǐng)求，如果有返回值的話，都會(huì)收到唯一日志ID，如圖：