SpringBoot多環境日誌配置

SpringBoot多環境日誌配置

SpringBoot 預設使用 LogBack 日誌系統

預設情況下，SpringBoot專案的日誌只會在控制檯輸入。

如果想查詢歷史日誌則無法找到，我們需要一個日誌系統來統一管理日誌。

一般正式專案會有單獨日誌系統，將日誌操作存入資料庫。

第一種方式是

在 application.properties或application.yml檔案 中新增

同時設定logging.file.name和logging.file.path，則logging.file.name會被忽略。

# 設定日誌檔案的具體名稱
logging.file.name=./logfile.log
 
# 或者設定日誌檔案的目錄
logging.file.path=/logfile/

更詳細的配置也可在這個配置檔案中寫

第二種方式 使用配置檔案

1、引入依賴

引入slf4j-api 是為了使用 @Slf4j 註解簡化操作

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

2、多環境配置

3、建立 logback xml

在 resource 下建立 logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <springProperty scope="context" name="applicationName"
                    source="spring.application.name" defaultValue="spring-restful-api"/>

    <!-- 單個日誌檔案的最大，尺寸 -->
    <springProperty scope="context" name="maxFileSize"
                    source="logging.file.max-size" defaultValue="10MB"/>
    <!-- 日誌保留時長 (天) -->
    <springProperty scope="context" name="maxHistory"
                    source="logging.file.max-history" defaultValue="180"/>
    <!-- 日誌檔案路徑 -->
    <springProperty scope="context" name="logDir"
                    source="logging.file.path" defaultValue="./logs"/>

    <contextName>${applicationName}</contextName>

    <!-- 彩色日誌 -->
    <!-- 彩色日誌依賴的渲染類 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>

    <!-- 彩色日誌格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID:- }) %clr(---){faint} %clr([%10t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wex"/>
    <property name="FILE_LOG_PATTERN"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%t] %-40.40logger{39} : %m%n%wex"/>

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

    <!-- info日誌 appender  -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${logDir}/info.log</file>
        <!-- 追加方式記錄日誌預設是true 日誌被追加到檔案結尾 -->
        <append>true</append>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <!-- 歸檔的日誌檔案的路徑，%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${logDir}/info/info-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日誌最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動檔案的大小，預設值是10MB，這裡設定為20MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>


        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只列印info日誌 -->
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- DEBUG日誌 appender  -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${logDir}/debug.log</file>
        <!-- 追加方式記錄日誌預設是true 日誌被追加到檔案結尾 -->
        <append>true</append>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <fileNamePattern>${logDir}/debug/debug-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日誌最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動檔案的大小，預設值是10MB，這裡設定為20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只列印DEBUG日誌 -->
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- WARN日誌 appender  -->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${logDir}/warn.log</file>
        <!-- 追加方式記錄日誌預設是true 日誌被追加到檔案結尾 -->
        <append>true</append>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <fileNamePattern>${logDir}/warn/warn-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日誌最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動檔案的大小，預設值是10MB，這裡設定為20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>


        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只列印WARN日誌 -->
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- error 日誌 appender  -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${logDir}/error.log</file>
        <!-- 追加方式記錄日誌預設是true 日誌被追加到檔案結尾 -->
        <append>true</append>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <fileNamePattern>${logDir}/error/error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日誌最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動檔案的大小，預設值是10MB，這裡設定為20MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只列印錯誤日誌 -->
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--  開發環境和測試環境，日誌輸出到控制檯  -->
    <springProfile name="dev|test">
        <!--控制檯和日誌檔案輸出級別-->
        <root level="INFO">
            <appender-ref ref="STDOUT"/>
        </root>
         <logger name="com.pyb.demo" level="debug"/> <!-- 開發和測試環境, 指定某包日誌為debug級 -->
    </springProfile>

    <!--  生產環境，日誌輸出到檔案 -->
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="INFO"/>
            <appender-ref ref="ERROR"/>
            <appender-ref ref="DEBUG"/>
            <appender-ref ref="WARN"/>
        </root>
        <logger name="com.pyb.demo" level="warn"/> <!-- 生產環境, 指定某包日誌為warn級 -->
        <logger name="com.pyb.demo.Application" level="info"/> <!-- 特定某個類列印info日誌, 比如application啟動成功後的提示語 -->
    </springProfile>

</configuration>

解釋

    <!--
        <logger>用來設定某一個包或者具體的某一個類的日誌列印級別、
        以及指定<appender>。<logger>僅有一個name屬性，
        一個可選的level和一個可選的addtivity屬性。
        name:用來指定受此logger約束的某一個包或者具體的某一個類。
        level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
              還有一個特殊值INHERITED或者同義詞NULL，代表強制執行上級的級別。
              如果未設定此屬性，那麼當前logger將會繼承上級的級別。
        addtivity:是否向上級logger傳遞列印資訊。預設是true。
        <logger name="org.springframework.web" level="info"/>
        <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
    -->

    <!--
        使用mybatis的時候，sql語句是debug下才會列印，而這裡我們只配置了info，所以想要檢視sql語句的話，有以下兩種操作：
        第一種把<root level="info">改成<root level="DEBUG">這樣就會列印sql，不過這樣日誌那邊會出現很多其他訊息
        第二種就是單獨給dao下目錄配置debug模式，程式碼如下，這樣配置sql語句會列印，其他還是正常info級別：
        【logging.level.org.mybatis=debug logging.level.dao=debug】
     -->

    <!--
        root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性
        level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設定為INHERITED或者同義詞NULL。預設是DEBUG
        可以包含零個或多個元素，標識這個appender將會新增到這個logger。
    -->

4.使用

完整策略

https://www.cnblogs.com/rwjnb/p/15520785.html

缺點（啟動專案可能會報錯）

spring會優先載入專案中或者jar包中的logback.xml並讀取裡邊的路徑（/workspace/api-default.log），然後再載入application.yml之後再載入我們的日誌檔案logback-spring.xml，專案部署在伺服器上執行一般不會用root這種許可權很大的使用者執行，許可權小的會對logback.xml裡的路徑可能會沒有操作許可權就會導致專案啟動失敗。