詳解Spring Boot下使用logback 記錄多個(gè)文件日志
背景
這兩天遇到一個(gè)比較有意思的日志問題.
近期對(duì)我之前的python代碼進(jìn)行java的重構(gòu), 一方面是因?yàn)閖ava使用的醫(yī)療庫(kù)非常健全穩(wěn)定, 可以商用. 另一方面是因?yàn)閖ava速度快, 這個(gè)庫(kù)的實(shí)現(xiàn)的效率也高, 性能是Python版本的好幾倍.
但是作為這個(gè)項(xiàng)目的唯一作者, 我的癖好也成為這個(gè)項(xiàng)目的風(fēng)格. 這個(gè)項(xiàng)目會(huì)給很多部署工程師使用. 當(dāng)然項(xiàng)目的可用性和性能作為第一考慮的因素, 但是作為一個(gè)懶人, 對(duì)使用軟件時(shí)候的復(fù)雜部署過程和混亂調(diào)試信息深惡痛絕. 所以我在項(xiàng)目中使用了高度可配置/易用和多文件日志.
說道多文件日志, 它的優(yōu)點(diǎn)是每個(gè)日志只容納自身的邏輯, 所以對(duì)于一般的入門開發(fā)者或者是初級(jí)運(yùn)維工程師查看起來非常方便.
初步嘗試
因?yàn)閟pring boot的配置一般來講是application.properties, 但是同時(shí)開發(fā)者可以使用yml格式的配置, 二者相比, yml文件更為簡(jiǎn)潔. 熟讀python之禪的我當(dāng)然是簡(jiǎn)潔勝于冗余選擇了yml.
發(fā)現(xiàn)spring-boot可以通過application.yml配置日志. 高興的配置一番之后發(fā)現(xiàn)沒法配置多個(gè)logger, 棄用! 改用logback-spring.xml(為什么不用logback.xml? 因?yàn)?spring這種文件可以獲取到spring配置中的變量.下面再說)
第一次實(shí)現(xiàn)
我有好幾個(gè)服務(wù)需要打日志. 一般來講我的日志風(fēng)格是 *.log 保存 INFO以上級(jí)別日志. *.err.log保存ERROR以上級(jí)別日志. 我如果每個(gè)文件日志都使用一個(gè)Appender的話, 配置文件太長(zhǎng)了. 而且很難看, 不是我的風(fēng)格.
Google了一下, 發(fā)現(xiàn)了這種方案:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
# 下面這一行的意思是使用application.yml中的global.log-dir變量
<springProperty scope="context" name="LOG_DIR" source="global.log-dir" defaultValue="./log/"/>
<!-- 追加器開始 -->
# 這個(gè)是一個(gè)可以定義變量的Appender
<appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
# 使用 LoggerNameBasedDiscriminator 這個(gè)類根據(jù)當(dāng)前Logger獲取變量
<discriminator class="com.utils.loggers.LoggerNameBasedDiscriminator">
<defaultValue>general</defaultValue>
</discriminator>
<sift>
# 根據(jù)變量loggerName名字生成根據(jù)日期滾動(dòng)的Appender
<appender name="FILE-${loggerName}" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>
${LOG_DIR}/${loggerName}.log
</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>
${LOG_DIR}/${loggerName}.%d{yyyy-MM-dd}.log.gz
</fileNamePattern>
<maxHistory>15</maxHistory>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level - %msg%n
</pattern>
</encoder>
</appender>
<appender name="FILE-ERROR-${loggerName}" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/${loggerName}.err.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>
${LOG_DIR}/${loggerName}.%d{yyyy-MM-dd}.err.log.gz
</fileNamePattern>
<maxHistory>15</maxHistory>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level - %msg%n
</pattern>
</encoder>
</appender>
</sift>
</appender>
<!-- 追加器結(jié)束 -->
<!-- 日志開始 -->
<logger name="com.some.service" level="INFO" additivity="false">
<appender-ref ref="SIFT"/>
</logger>
<!-- 日志結(jié)束 -->
</configuration>
下的是對(duì)應(yīng)的 LoggerNameBasedDiscriminator 類
package com.utils.loggers;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.sift.AbstractDiscriminator;
public class LoggerNameBasedDiscriminator extends AbstractDiscriminator<ILoggingEvent> {
private static final String KEY = "loggerName";
private String defaultValue;
public String getDefaultValue() {
return defaultValue;
}
public void setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
}
# 這就是之所以xml里面可以引用loggerName變量的原因
public String getKey() {
return KEY;
}
public void setKey() {
throw new UnsupportedOperationException("Key not settable. Using " + KEY);
}
public String getDiscriminatingValue(ILoggingEvent e) {
String loggerName = e.getLoggerName();
if (loggerName == null)
return defaultValue;
else {
String[] split = loggerName.split("\\.");
return split[split.length - 1];
}
}
}
最開始我的日志里面沒有報(bào)錯(cuò)信息, 正常的生成INFO日志. 但是后來發(fā)現(xiàn)事情好像不是想象的那樣
問題出現(xiàn)
后來我把程序改成多線程. 發(fā)現(xiàn)所有涉及到多線程的服務(wù)日志里面都沒信息了. Google半天, 發(fā)現(xiàn)幾個(gè)令我震驚的真相:
- 真相1: 所有滾動(dòng)Appender都不支持異步追加 (其實(shí)也不是, 但是那種方式需要寫死日志文件名, 不推薦, 不講)
- 真相2: SiftingAppender 內(nèi)部最多嵌套一個(gè)Appender. 所以理論上我的ERROR的日志里面應(yīng)該永遠(yuǎn)不會(huì)有內(nèi)容.
問題解決
對(duì)于之前的兩個(gè)問題, 分而治之.
不支持異步
再次谷歌(到這里讀者基本上發(fā)現(xiàn)了我搬磚的本質(zhì)), 發(fā)現(xiàn)有個(gè)Appender名字叫AsyncAppender, 這玩意是一個(gè)其他Appender的Wrapper. 說白了, 就是你打日志的命令是異步的, 放到隊(duì)列里面, 而它真正的打日志的動(dòng)作是一個(gè)單獨(dú)的同步線程. 這就牛逼了, 使用這玩意收集我所有日志, 然后再轉(zhuǎn)發(fā)給SiftingAppender 進(jìn)行分發(fā)即可.
SiftingAppender 內(nèi)部最多嵌套一個(gè)Appender
這個(gè)好辦, 把INFO的Appender和ERROR的Appender拆開放到兩個(gè)SiftingAppender里面就行了, 不過這樣的話, 前面提到的的AsyncAppender 也要寫兩個(gè).
最后, logback-spring.xml文件如下
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<springProperty scope="context" name="LOG_DIR" source="global.log-dir" defaultValue="./log/"/>
<!-- 追加器開始 -->
<appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
<discriminator class="com.utils.loggers.LoggerNameBasedDiscriminator">
</discriminator>
<sift>
<appender name="FILE-${loggerName}"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/${loggerName}.log</file>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>
${LOG_DIR}/${loggerName}.%d{yyyy-MM-dd}.log
</fileNamePattern>
<maxHistory>15</maxHistory>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level - %msg%n
</pattern>
</encoder>
</appender>
</sift>
</appender>
<appender name="SIFT-ERR" class="ch.qos.logback.classic.sift.SiftingAppender">
<discriminator class="com.infervision.utils.loggers.LoggerNameBasedDiscriminator">
</discriminator>
<sift>
<appender name="FILE-ERROR-${loggerName}" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/${loggerName}.err.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>
${LOG_DIR}/${loggerName}.%d{yyyy-MM-dd}.err.log
</fileNamePattern>
<maxHistory>15</maxHistory>
<totalSizeCap>50MB</totalSizeCap>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level - %msg%n
</pattern>
</encoder>
</appender>
</sift>
</appender>
<!-- 異步輸出 -->
<appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender">
<!-- 不丟失日志.默認(rèn)的,如果隊(duì)列的80%已滿,則會(huì)丟棄TRACT、DEBUG、INFO級(jí)別的日志 -->
<discardingThreshold >0</discardingThreshold>
<!-- 更改默認(rèn)的隊(duì)列的深度,該值會(huì)影響性能.默認(rèn)值為256 -->
<queueSize>512</queueSize>
<!-- 添加附加的appender,最多只能添加一個(gè) -->
<appender-ref ref ="SIFT"/>
</appender>
<!-- 異步輸出 -->
<appender name ="ASYNC-ERR" class= "ch.qos.logback.classic.AsyncAppender">
<!-- 不丟失日志.默認(rèn)的,如果隊(duì)列的80%已滿,則會(huì)丟棄TRACT、DEBUG、INFO級(jí)別的日志 -->
<discardingThreshold >0</discardingThreshold>
<!-- 更改默認(rèn)的隊(duì)列的深度,該值會(huì)影響性能.默認(rèn)值為256 -->
<queueSize>512</queueSize>
<!-- 添加附加的appender,最多只能添加一個(gè) -->
<appender-ref ref ="SIFT-ERR"/>
</appender>
<!-- 追加器結(jié)束 -->
<!-- 日志開始 -->
<logger name="com.some.service" level="INFO" additivity="false">
<appender-ref ref="ASYNC"/>
</logger>
<!-- 日志結(jié)束 -->
</configuration>
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
在Java中,字符串拼接是開發(fā)過程中非常常見的操作,根據(jù)不同的需求和性能考慮,有多種方式可以實(shí)現(xiàn)字符串的拼接,本文給大家介紹了五種拼接方式,并通過代碼講解的非常詳細(xì),需要的朋友可以參考下2024-10-10
解決persistence.xml配置文件修改存放路徑的問題
這篇文章主要介紹了解決persistence.xml配置文件修改存放路徑的問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
這篇文章主要介紹了 Web Service 運(yùn)行原理詳細(xì)介紹的相關(guān)資料,需要的朋友可以參考下2016-10-10
如何使用jenkins實(shí)現(xiàn)發(fā)布部分更新文件
這篇文章主要介紹了如何使用jenkins實(shí)現(xiàn)發(fā)布部分更新文件,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
java異常繼承何類,運(yùn)行時(shí)異常與一般異常的區(qū)別(詳解)
下面小編就為大家?guī)硪黄猨ava異常繼承何類,運(yùn)行時(shí)異常與一般異常的區(qū)別(詳解)。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-11-11
下面小編就為大家?guī)硪黄獪\談Java中的四種引用方式的區(qū)別。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2016-09-09
這篇文章主要介紹了SpringBoot接入支付寶支付的方法步驟，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
SpringBoot切面攔截@PathVariable參數(shù)及拋出異常的全局處理方式
這篇文章主要介紹了SpringBoot切面攔截@PathVariable參數(shù)及拋出異常的全局處理方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-08-08
Java中二叉樹數(shù)據(jù)結(jié)構(gòu)的實(shí)現(xiàn)示例
這篇文章主要介紹了Java中二叉樹數(shù)據(jù)結(jié)構(gòu)的實(shí)現(xiàn)示例,包括前中后序遍歷和求二叉樹深度的方法,需要的朋友可以參考下2015-08-08
java編程隊(duì)列數(shù)據(jù)結(jié)構(gòu)代碼示例
這篇文章主要介紹了java編程隊(duì)列數(shù)據(jù)結(jié)構(gòu)代碼示例，簡(jiǎn)單介紹了隊(duì)列的相關(guān)基礎(chǔ)知識(shí)，然后通過實(shí)例向大家展示其實(shí)現(xiàn)方法，具有一定參考價(jià)值，需要的朋友可以了解下。2017-11-11