SpringBoot之logback配置檔案

一灰灰發表於2018-06-23
Spring Boot

logo

SpringBoot配置logback

專案的日誌配置屬於比較常見的case了，之前接觸和使用的都是Spring結合xml的方式，引入幾個依賴，然後寫個 logback.xml 配置檔案即可，那麼在SpringBoot中可以怎麼做？

I. 配置說明

在resource目錄下，新建一個日誌檔案: logback-spring.xml，內容如下

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- %m輸出的資訊,%p日誌級別,%t執行緒名,%d日期,%c類的全名,%i索引【從數字0開始遞增】,,, -->
    <!-- appender是configuration的子節點，是負責寫日誌的元件。 -->
    <!-- ConsoleAppender：把日誌輸出到控制檯 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d [%t] %-5level %logger{36}.%M\(%file:%line\) - %msg%n</pattern>
            <!-- 控制檯也要使用UTF-8，不要使用GBK，否則會中文亂碼 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="errorAlarm" class="com.git.hui.story.common.alarm.ServiceAlarm">
        <!--如果只是想要 Error 級別的日誌，那麼需要過濾一下，預設是 info 級別的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>

    <!-- RollingFileAppender：滾動記錄檔案，先將日誌記錄到指定檔案，當符合某個條件時，將日誌記錄到其他檔案 -->
    <!-- 以下的大概意思是：1.先按日期存日誌，日期變了，將前一天的日誌檔名重新命名為XXX%日期%索引，新的日誌仍然是demo.log -->
    <!--             2.如果日期沒有發生變化，但是當前日誌的檔案大小超過1KB時，對當前日誌進行分割 重新命名-->
    <appender name="story" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--如果只是想要 Error 級別的日誌，那麼需要過濾一下，預設是 info 級別的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <File>logs/story.log</File>
        <!-- rollingPolicy:當發生滾動時，決定 RollingFileAppender 的行為，涉及檔案移動和重新命名。 -->
        <!-- TimeBasedRollingPolicy： 最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 活動檔案的名字會根據fileNamePattern的值，每隔一段時間改變一次 -->
            <!-- 檔名：log/demo.2018-06-23.0.log -->
            <fileNamePattern>logs/arch/story.%d.%i.log</fileNamePattern>
            <!-- 每產生一個日誌檔案，該日誌檔案的儲存期限為3天 -->
            <maxHistory>3</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動檔案的大小，預設值是10MB，測試時可改成1KB看效果 -->
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <!-- pattern節點，用來設定日誌的輸入格式 -->
            <pattern>
                %d %p (%file:%line\)- %m%n
            </pattern>
            <!-- 記錄日誌的編碼:此處設定字符集 - -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 指定專案中某個包，當有日誌操作行為時的日誌記錄級別 -->
    <!-- 級別依次為【從高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
    <!-- additivity=false 表示匹配之後，不再繼續傳遞給其他的logger-->
    <logger name="com.git.hui" level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="story"/>
        <appender-ref ref="errorAlarm"/>
    </logger>

    <logger name="com.github.hui" level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="story"/>
        <appender-ref ref="errorAlarm"/>
    </logger>

    <!-- 控制檯輸出日誌級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>
複製程式碼

上面是一個基礎的日誌輸出配置，額外說明幾點：

  • 配置檔名能否是其他的
  • 在appender標籤中對日誌級別進行過濾
  • 一個logger標籤下有多個appender-ref
  • 自定義的appender實現類

II. 擴充套件

1. 配置檔名

配置檔名預設為 logback-spring.xml，如果我希望改成 mylog.xml 可以怎麼辦？

主要是修改 application.yml 配置檔案中的引數指定

logging:
  config: classpath:mylog.xml
複製程式碼

2. logger標籤

logger標籤下可以接上多個<appender-ref>, 即表示命中的日誌，會採用這多個appender,都列印一遍，比如上面的，來一條日誌，在控制檯會輸出，在日誌檔案會輸出，如果是error日誌，還會觸發ServiceAlarm的邏輯

因此就有一個問題，我們可能希望不同的內部有個日誌級別的控制，比如控制檯可以輸出debug日誌，而日誌檔案中只輸出info級別的，這就需要在appender標籤內新增filter屬性了

<appender name="errorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--如果只是想要 Error 級別的日誌，那麼需要過濾一下，預設是 info 級別的，ThresholdFilter-->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>WARN</level>
    </filter>
</appender>
複製程式碼

3. 自定義appender實現類

前面的配置檔案中，使用了一個自定義的 AlarmService, 主要是在接收到錯誤日誌時，實現自定義報警,對應的簡單實現如下

/**
 * 報警
 * Created by @author yihui in 16:43 18/6/23.
 */
public class ServiceAlarm extends AppenderBase<ILoggingEvent> {
    private static final long INTERVAL = 10 * 1000 * 60;
    private long lastAlarmTime = 0;

    @Override
    protected void append(ILoggingEvent iLoggingEvent) {
        if (canAlarm()) {
            doAlarm(iLoggingEvent.getFormattedMessage());
        }
    }

    private boolean canAlarm() {
        long now = System.currentTimeMillis();
        if (now - lastAlarmTime >= INTERVAL) {
            lastAlarmTime = now;
            return true;
        } else {
            return false;
        }
    }

    private void doAlarm(String content) {
        try {
            EmailWrapper.sendMail("異常報警", "bangzewu@126.com", content);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
複製程式碼

4. 其他

關於logback的配置檔案中的詳細引數，可以參考博文:

III. 其他

1. 一灰灰Blog： https://liuyueyi.github.io/hexblog

一灰灰的個人部落格，記錄所有學習和工作中的博文，歡迎大家前去逛逛

2. 宣告

盡信書則不如，已上內容，純屬一家之言，因個人能力有限，難免有疏漏和錯誤之處，如發現bug或者有更好的建議，歡迎批評指正，不吝感激

3. 掃描關注

blogInfoV2.png

相關文章