logback和log4j日志框架堆棧信息添加TraceId方式

更新時間：2023年09月27日 09:27:50 作者：lllllLiangjia

這篇文章主要介紹了logback和log4j日志框架堆棧信息添加TraceId方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

背景

TraceId是我在項目上自定義的，作為鏈路追蹤來使用。至于為什么沒有用市面上skywalking此類現(xiàn)成的鏈路追蹤，是因為目前這個項目是boot單體，也不是分布式，不想引入過多比較復(fù)雜的依賴項，造成不必要的維護麻煩。

使用traceId只是來準確定位某個請求的日志信息，自己實現(xiàn)的話比較輕量化，也能夠滿足項目的開發(fā)和維護需求。

當請求訪問時，被過濾器攔截到，生成一個唯一的traceId存放在MDC中（分布式項目可以通過請求頭獲取上游服務(wù)傳過來的traceId），MDC是ThreadLocal類型線程安全的。

日志xml配置寫上traceId會自動讀取MDC。

logback日志框架

由于之前項目是使用的logback日志框架，如果只在xml日志文件中配置traceId的話，當報錯時候輸出的堆棧信息內(nèi)不會保存traceId。

到時候線上排查問題，無法通過grep命令篩選出來報錯的堆棧信息，也就不能快速定位代碼中的報錯位置。

堆棧信息不攜帶traceId

xml配置文件中的配置

堆棧信息攜帶traceId

logback想要在堆棧信息中添加traceId需要繼承ThrowableProxyConverter，重寫里面的方法。

import ch.qos.logback.classic.pattern.ThrowableProxyConverter;
import ch.qos.logback.classic.spi.IThrowableProxy;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.MDC;
public class CompressedStackTraceConverter extends ThrowableProxyConverter {
    public CompressedStackTraceConverter() {
    }
    @Override
    protected String throwableProxyToString(IThrowableProxy tp) {
        String original = super.throwableProxyToString(tp);
        String traceId = MDC.get("traceId");
        if (StringUtils.isBlank(traceId)) {
            traceId = "";
        }
        traceId = "\t[ably-stack]\t[" + traceId + "]";
        return original.replaceAll("\n", traceId + "\n");
    }
}

此時的xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <conversionRule conversionWord="ex"
                    converterClass="com.example.springbootdemo.configuration.httpglobal.CompressedStackTraceConverter"/>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern xml:space="preserve">
                %d{yyyy-MM-dd HH:mm:ss.SSS}|-|%lsn|-|%thread|-|%X{traceType}|-|%X{traceId}|-|%logger{80}:%L|-|%msg|-|%ex|-|%n
            </pattern>
        </encoder>
    </appender>
    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

這樣logback框架就可以打印堆棧信息的時候攜帶traceId了