Logback配置文件這么寫，還愁不會整理日志揍很？

摘要：

1.日志輸出到文件并根據(jù)LEVEL級別將日志分類保存到不同文件

2.通過異步輸出日志減少磁盤IO提高性能

3.異步輸出日志的原理

1、配置文件logback-spring.xml

SpringBoot工程自帶logback和slf4j的依賴枪孩，所以重點放在編寫配置文件上憔晒，需要引入什么依賴，日志依賴沖突統(tǒng)統(tǒng)都不需要我們管了蔑舞。

logback框架會默認(rèn)加載classpath下命名為logback-spring.xml或logback.xml的配置文件拒担。

如果將所有日志都存儲在一個文件中，文件大小也隨著應(yīng)用的運行越來越大并且不好排查問題攻询，正確的做法應(yīng)該是將error日志和其他日志分開从撼，并且不同級別的日志根據(jù)時間段進行記錄存儲。

配置文件：

<?xml version="1.0" encoding="UTF-8"?> <configuration debug="true">  <property name="PROJECT_NAME" value="project-api" />  <property name="LOG_HOME" value="logs" />  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <withJansi>true</withJansi> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">  <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender>  <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/${PROJECT_NAME}/error.log</file>  <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">  <FileNamePattern>${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/error.%i.zip</FileNamePattern>  <MaxHistory>3650</MaxHistory>  <MaxFileSize>100MB</MaxFileSize> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">  <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender>  <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/${PROJECT_NAME}/info.log</file>  <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">  <FileNamePattern>${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/info.%i.zip</FileNamePattern>  <MaxHistory>3650</MaxHistory>  <MaxFileSize>100MB</MaxFileSize> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">  <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender>  <appender name="SQL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/${PROJECT_NAME}/sql.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">  <FileNamePattern>${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/sql.%i.zip</FileNamePattern>  <MaxHistory>3650</MaxHistory>  <MaxFileSize>100MB</MaxFileSize> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">  <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender>  <appender name="REQUEST_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/${PROJECT_NAME}/request.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">  <FileNamePattern>${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/request.%i.zip</FileNamePattern>  <MaxHistory>3650</MaxHistory>  <MaxFileSize>100MB</MaxFileSize> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">  <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line]- %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender>  <appender name="ASYNC_INFO_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="INFO_FILE"/> </appender>  <appender name="ASYNC_ERROR_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="ERROR_FILE"/> </appender>  <appender name="ASYNC_SQL_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="SQL_FILE"/> </appender>  <appender name="ASYNC_REQUEST_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="REQUEST_FILE"/> </appender>  <logger name="error" additivity="true"> <appender-ref ref="ERROR_FILE"/> </logger>  <logger name="info" additivity="true"> <appender-ref ref="INFO_FILE"/> </logger>  <logger name="request" level="INFO" additivity="false"> <appender-ref ref="REQUEST_FILE" /> </logger>  <logger name="org.hibernate.SQL" additivity="false"> <level value="DEBUG" /> <appender-ref ref="SQL_FILE" /> </logger>  <logger name="org.hibernate.type.descriptor.sql.BasicBinder" additivity="false" level="TRACE"> <level value="TRACE" /> <appender-ref ref="SQL_FILE" /> </logger>  <springProfile name="dev"> <root level="INFO"> <appender-ref ref="CONSOLE" /> <appender-ref ref="ERROR_FILE" /> <appender-ref ref="INFO_FILE" /> </root> </springProfile>  <springProfile name="test"> <root level="INFO"> <appender-ref ref="CONSOLE" /> <appender-ref ref="ERROR_FILE" /> <appender-ref ref="INFO_FILE" /> </root> </springProfile>  <springProfile name="prod"> <root level="INFO"> <appender-ref ref="CONSOLE" /> <appender-ref ref="ERROR_FILE" /> <appender-ref ref="INFO_FILE" /> </root> </springProfile> </configuration>

標(biāo)簽說明：

<root>標(biāo)簽，必填標(biāo)簽觉壶，用來指定最基礎(chǔ)的日志輸出級別
<appender-ref>標(biāo)簽脑题，添加append
<append>標(biāo)簽，通過使用該標(biāo)簽指定日志的收集策略
<filter>標(biāo)簽铜靶，通過使用該標(biāo)簽指定過濾策略
<level>標(biāo)簽指定過濾的類型
<encoder>標(biāo)簽旭蠕，使用該標(biāo)簽下的<pattern>標(biāo)簽指定日志輸出格式
<rollingPolicy>標(biāo)簽指定收集策略，比如基于時間進行收集
<fileNamePattern>標(biāo)簽指定生成日志保存地址旷坦，通過這樣配置已經(jīng)實現(xiàn)了分類分日期收集日志的目標(biāo)了

name屬性指定appender命名
class屬性指定輸出策略，通常有兩種佑稠，控制臺輸出和文件輸出秒梅，文件輸出就是將日志進行一個持久化
ConsoleAppender將日志輸出到控制臺

部分截圖展示：

目錄：

error.log

info.log

sql.log

request.log

2、logback 高級特性異步輸出日志

如果不配置異步輸出規(guī)則舌胶，那么默認(rèn)日志配置方式是基于同步的捆蜀，每次日志輸出到文件都會進行一次磁盤IO。

采用異步寫日志的方式而不讓此次寫日志發(fā)生磁盤IO，阻塞線程從而造成不必要的性能損耗辆它。

異步輸出日志的方式很簡單誊薄，添加一個基于異步寫日志的appender，并指向原先配置的appender即可锰茉。

異步輸出配置：

<appender name="ASYNC_INFO_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="INFO_FILE"/> </appender>  <appender name="ASYNC_ERROR_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="ERROR_FILE"/> </appender>  <appender name="ASYNC_SQL_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="SQL_FILE"/> </appender>  <appender name="ASYNC_REQUEST_FILE" class="ch.qos.logback.classic.AsyncAppender">  <queueSize>256</queueSize>  <discardingThreshold>0</discardingThreshold>  <appender-ref ref="REQUEST_FILE"/> </appender>

參數(shù)配置：

參數(shù)名稱參數(shù)類型建議值說明queueSizeintqueueSize計算

example：假設(shè)IO影響30s，日志和qps比例是1:1赡模，單容器壓測值1500 qps則可以推算出queue size的值田炭，queueSize的設(shè)置公式：30 ＊1500=45000。阻塞隊列的最大容量漓柑。默認(rèn)情況下教硫，queueSize設(shè)置為256叨吮。discardingThresholdint

使用默認(rèn)值20，或者設(shè)置大于0瞬矩。

如果設(shè)置discardingThreshold＝0茶鉴，表示queue 滿了，不丟棄景用，block線程涵叮。

默認(rèn)情況下，當(dāng)阻塞隊列剩余20%的容量時丛肢，它將丟棄級別跟蹤围肥、調(diào)試和信息事件，只保留級別警告和錯誤事件蜂怎。要保留所有事件穆刻，請將discardingThreshold設(shè)置為0。neverBlockbooleantrue如果為false（默認(rèn)值）杠步，則追加程序?qū)⒆柚棺芳拥酵暾犃星馕埃皇莵G失消息。設(shè)置為true時幽歼，附加程序只會丟棄消息朵锣，不會阻止您的應(yīng)用程序。

官方文檔鏈接：http://logback.qos.ch/manual/appenders.html#AsyncAppender

3甸私、異步日志輸出原理

異步輸出日志中最關(guān)鍵的就是配置文件中ch.qos.logback.classic包下AsyncAppenderBase類中的append方法诚些，查看該方法的源碼:@Override protected void append(E eventObject) { if (isQueueBelowDiscardingThreshold() && isDiscardable(eventObject)) { return; } preprocess(eventObject); put(eventObject); }

通過隊列情況判斷是否需要丟棄日志，不丟棄的話將它放到阻塞隊列中皇型，通過查看代碼诬烹，這個阻塞隊列為queueSize，默認(rèn)大小為256弃鸦，可以通過配置文件進行修改绞吁。

/** * The default buffer size. */ public static final int DEFAULT_QUEUE_SIZE = 256; int queueSize = DEFAULT_QUEUE_SIZE;

Logger.info(...)到append(...)就結(jié)束了，只做了將日志塞入到阻塞隊列的事唬格，然后繼續(xù)執(zhí)行Logger.info(...)下面的語句了家破。在AsyncAppenderBase類中定義了一個Worker線程，run()方法中的代碼如下:

Worker worker = new Worker();class Worker extends Thread { public void run() { AsyncAppenderBase<E> parent = AsyncAppenderBase.this; AppenderAttachableImpl<E> aai = parent.aai; // loop while the parent is started while (parent.isStarted()) { try { E e = parent.blockingQueue.take(); aai.appendLoopOnAppenders(e); } catch (InterruptedException ie) { break; } } addInfo("Worker thread will flush remaining events before exiting. "); for (E e : parent.blockingQueue) { aai.appendLoopOnAppenders(e); parent.blockingQueue.remove(e); } aai.detachAndStopAllAppenders(); } }

從阻塞隊列中取出一個日志购岗，并調(diào)用AppenderAttachableImpl類中的appendLoopOnAppenders方法維護一個Append列表汰聋。

最主要的兩個方法就是encode和write方法，前一個法方會根據(jù)配置文件中encode指定的方式轉(zhuǎn)化為字節(jié)碼喊积，后一個方法將轉(zhuǎn)化成的字節(jié)碼寫入到文件中去烹困。

所以寫文件是通過新起一個線程去完成的，主線程將日志放到阻塞隊列中注服，然后又去執(zhí)行其他任務(wù)韭邓。

Logback配置文件這么寫，還愁不會整理日志？

Logback配置文件這么寫，還愁不會整理日志侣颂？