SpringBoot項目配置JSON日誌格式輸出

SpringBoot項目配置JSON日誌格式輸出

採用logstash-logback-encoder來實現JSON日誌輸出

引入依賴

implementation 'net.logstash.logback:logstash-logback-encoder:5.0'
compileOnly 'org.projectlombok:lombok'
compile group: 'org.codehaus.janino', name: 'janino', version: '3.1.0'
compile group: 'org.codehaus.janino', name: 'commons-compiler', version: '3.1.0'

創建日誌配置文件logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="600000">
    <!--定義日誌文件的存儲地址 勿在 LogBack 的配置中使用相對路徑 -->
    <!--    <property name="LOG_HOME" value="/data/logs" />-->
    <property name="LOG_HOME" value="/data/logs" />
    <contextName>${HOSTNAME}</contextName>
    <springProperty scope="context" name="appName"
                    source="spring.application.name" />
    <springProperty scope="context" name="ip"
                    source="spring.cloud.client.ipAddress" />
    <property name="osName" value="${os.name}" />

    <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日誌消息，%n是換行符 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %line [%yellow(%X{X-B3-TraceId}),%green(%X{X-B3-SpanId})] [%yellow(%thread)] %green(%logger{30}) %msg%n" />

    <!-- 控制檯輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>

    <if condition='p("osName").contains("Linux")'>
        <then>
            <!-- 按照每天生成日誌文件 -->
            <appender name="FILE"
                      class="ch.qos.logback.core.rolling.RollingFileAppender">
                <!-- 正在記錄的日誌文件的路徑及文件名 -->
                <file>${LOG_HOME}/${appName}.log</file>
                <rollingPolicy
                        class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                    <!--日誌文件輸出的文件名 -->
                    <FileNamePattern>${LOG_HOME}/${appName}.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
                    <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                        <maxFileSize>1MB</maxFileSize>
                    </timeBasedFileNamingAndTriggeringPolicy>
                    <!-- 每個日誌文件到100MB的時候開始切分，最多保留30天，但最大到20GB，哪怕沒到30天也要刪除多餘的日誌 -->
                    <MaxHistory>30</MaxHistory>
                    <maxFileSize>100MB</maxFileSize>
                    <totalSizeCap>20GB</totalSizeCap>
                </rollingPolicy>
                <encoder
                        class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
                    <providers>
                        <timestamp>
                            <timeZone>UTC</timeZone>
                        </timestamp>
                        <pattern>
                            <pattern>
                                {
                                "level": "%level",
                                "appName": "${appName}",
                                "requestId": "%X{requestId}",
                                "remoteIp": "%X{remoteIp}",
                                "traceId": "%X{X-B3-TraceId:-}",
                                "spanId": "%X{X-B3-SpanId:-}",
                                "parent": "%X{X-B3-ParentSpanId:-}",
                                "thread": "%thread",
                                "class": "%logger{40}",
                                "line": "%line",
                                "message": "%message",
                                "stack_trace": "%exception"
                                }
                            </pattern>
                        </pattern>
                        <stackTrace>
                            <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
                                <maxDepthPerThrowable>100</maxDepthPerThrowable>
                                <maxLength>20480</maxLength>
                                <rootCauseFirst>true</rootCauseFirst>
                            </throwableConverter>
                        </stackTrace>
                    </providers>
                </encoder>
            </appender>
        </then>
    </if>

    <!-- 日誌輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />

        <if condition='p("osName").contains("Linux")'>
            <then>
                <appender-ref ref="FILE" />
            </then>
        </if>
    </root>
</configuration>

• LOG_HOME： 日誌輸出目錄
• appName：服務名稱
• osName：操作系統名稱
• CONSOLE_LOG_PATTERN：控制檯日誌輸出格式
• p(“osName”).contains(“Linux”)：判斷是否是linux系統，設置只有Linux系統下才輸出JSON格式日誌，本地開發一般都是windows或者Mac，所以可以按照操作系統來判斷是否輸出JSON日誌