SpringBoot添加日志鏈TraceId方式

更新時間：2025年08月15日 09:41:40 作者：yooxinz

配置SpringBoot日志TraceId,利用MDC和攔截器注入traceid變量,通過logback-spring.xml設(shè)置,使%X{traceid}可獲取,提升問題排查效率

通過MDC添加TraceId變量

創(chuàng)建攔截器添加traceId

@Component
@Slf4j
public class TraceFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
        // "traceId"
        MDC.put("traceid", getTraceId());
        filterChain.doFilter(httpServletRequest, httpServletResponse);
    }

    private String getTraceId() {
        long timestamp = System.currentTimeMillis();
        UUID uuid = UUID.randomUUID();
        String uniqueId = timestamp + uuid.toString().replace("-", "");
        return uniqueId;
    }
}

配置日志文件

application配置日志配置文件:

logging:
  config: classpath:logback-spring.xml

logback-spring.xml文件: 通過 %X{traceid} 獲取filter中配置的變量

<?xml version="1.0" encoding="UTF-8"?>

<!-- 從高到地低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志輸出規(guī)則 根據(jù)當(dāng)前ROOT 級別，日志輸出時，級別高于root默認的級別時 會輸出 -->
<!-- 以下 每個配置的 filter 是過濾掉輸出文件里面，會出現(xiàn)高級別文件，依然出現(xiàn)低級別的日志信息，通過filter 過濾只記錄本級別的日志 -->


<!-- 屬性描述 scan：性設(shè)置為true時，配置文件如果發(fā)生改變，將會被重新加載，默認值為true scanPeriod:設(shè)置監(jiān)測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當(dāng)scan為true時，此屬性生效。默認的時間間隔為1分鐘。
	debug:當(dāng)此屬性設(shè)置為true時，將打印出logback內(nèi)部日志信息，實時查看logback運行狀態(tài)。默認值為false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>d1money-web-ys-ems</contextName>

    <!-- 日志最大的歷史 30天 -->
    <property name="maxHistory" value="30" />
    <property name="maxFileSize" value="100MB" />


    <!-- ConsoleAppender 控制臺輸出日志 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- Minimum logging level to be presented in the console logs -->
            <level>INFO</level>
        </filter>
        <!-- 對日志進行格式化 -->
        <encoder>
            <pattern>
                %date{yyyy-MM-dd HH:mm:ss} | %X{traceid} | %highlight(%5p) | %green(%thread) | %boldMagenta(%logger) | %msg%n
            </pattern>
        </encoder>
    </appender>

    <!-- INFO級別日志 -->
    <!-- 滾動記錄文件，先將日志記錄到指定文件，當(dāng)符合某個條件時，將日志記錄到其他文件 RollingFileAppender -->
    <appender name="FILE"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- Minimum logging level to be presented in the console logs -->
            <level>INFO</level>
        </filter>
        <!-- 最常用的滾動策略，它根據(jù)時間來制定滾動策略.既負責(zé)滾動也負責(zé)出發(fā)滾動 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志輸出位置 可相對、和絕對路徑 -->
            <fileNamePattern>
                log/app.%d{yyyy-MM-dd}.%i.log
            </fileNamePattern>
            <!-- 可選節(jié)點，控制保留的歸檔文件的最大數(shù)量，超出數(shù)量就刪除舊文件假設(shè)設(shè)置每個月滾動，且<maxHistory>是6， 則只保存最近6個月的文件，刪除之前的舊文件。注意，刪除舊文件是，那些為了歸檔而創(chuàng)建的目錄也會被刪除 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>

        </rollingPolicy>


        <!-- 按照固定窗口模式生成日志文件，當(dāng)文件大于20MB時，生成新的日志文件。窗口大小是1到3，當(dāng)保存了3個歸檔文件后，將覆蓋最早的日志。
            <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/.log.zip</fileNamePattern> <minIndex>1</minIndex>
            <maxIndex>3</maxIndex> </rollingPolicy> -->
        <!-- 查看當(dāng)前活動文件的大小，如果超過指定大小會告知RollingFileAppender 觸發(fā)當(dāng)前活動文件滾動 <triggeringPolicy
            class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
            </triggeringPolicy> -->

        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="java.sql.PreparedStatement" value="DEBUG" />
    <logger name="java.sql.Connection" value="DEBUG" />
    <logger name="java.sql.Statement" value="DEBUG" />
    <logger name="com.ibatis" value="DEBUG" />
    <logger name="com.ibatis.common.jdbc.SimpleDataSource" value="DEBUG" />
    <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG" />
    <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate"
            value="DEBUG" />
    <logger name="com.apache.ibatis" level="TRACE" />

    <!-- root級別 INFO -->
    <root level="info">
        <!-- 文件輸出 -->
        <appender-ref ref="FILE" />
        <!-- 控制臺輸出 -->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>