摘要：html
1.日誌輸出到文件並根據LEVEL級別將日誌分類保存到不一樣文件spring
2.經過異步輸出日誌減小磁盤IO提升性能sql
3.異步輸出日誌的原理api
一、配置文件logback-spring.xmlapp
SpringBoot工程自帶logback和slf4j的依賴，因此重點放在編寫配置文件上，需要引入什麼依賴，日誌依賴衝突通通都不須要咱們管了。框架
logback框架會默認加載classpath下命名爲logback-spring.xml或logback.xml的配置文件。異步
若是將全部日誌都存儲在一個文件中，文件大小也隨着應用的運行愈來愈大而且很差排查問題，正確的作法應該是將error日誌和其餘日誌分開，而且不一樣級別的日誌根據時間段進行記錄存儲。ide
配置文件：oop
<?xml version="1.0" encoding="UTF-8"?> <configuration debug="true"> <!-- 項目名稱 --> <property name="PROJECT_NAME" value="project-api" /> <!--定義日誌文件的存儲地址 勿在 LogBack 的配置中使用相對路徑--> <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"> <!-- 格式化輸出: %d: 日期; %-5level: 級別從左顯示5個字符寬度; %thread: 線程名; %logger: 類名; %M: 方法名; %line: 行號; %msg: 日誌消息; %n: 換行符 --> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- ERROR日誌文件,記錄錯誤日誌 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/${PROJECT_NAME}/error.log</file> <!-- 過濾器，只打印ERROR級別的日誌 --> <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"> <!-- 格式化輸出: %d: 日期; %-5level: 級別從左顯示5個字符寬度; %thread: 線程名; %logger: 類名; %M: 方法名; %line: 行號; %msg: 日誌消息; %n: 換行符 --> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- INFO日誌文件，用於記錄重要日誌信息 --> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/${PROJECT_NAME}/info.log</file> <!-- 過濾器，只打印INFO級別的日誌 --> <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"> <!-- 格式化輸出: %d: 日期; %-5level: 級別從左顯示5個字符寬度; %thread: 線程名; %logger: 類名; %M: 方法名; %line: 行號; %msg: 日誌消息; %n: 換行符 --> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- 打印的SQL日誌文件，用於執行的SQL語句和參數信息 --> <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"> <!-- 格式化輸出: %d: 日期; %-5level: 級別從左顯示5個字符寬度; %thread: 線程名; %logger: 類名; %M: 方法名; %line: 行號; %msg: 日誌消息; %n: 換行符 --> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- API請求被訪問的日誌文件，記錄請求的URL和攜帶的參數 --> <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"> <!-- 格式化輸出: %d: 日期; %-5level: 級別從左顯示5個字符寬度; %thread: 線程名; %logger: 類名; %M: 方法名; %line: 行號; %msg: 日誌消息; %n: 換行符 --> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line]- %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- 異步輸出INFO_FILE --> <appender name="ASYNC_INFO_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="INFO_FILE"/> </appender> <!-- 異步輸出ERROR_FILE --> <appender name="ASYNC_ERROR_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="ERROR_FILE"/> </appender> <!-- 異步輸出SQL_FILE --> <appender name="ASYNC_SQL_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="SQL_FILE"/> </appender> <!-- 異步輸出REQUEST_FILE --> <appender name="ASYNC_REQUEST_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="REQUEST_FILE"/> </appender> <!-- 輸出error信息到文件--> <logger name="error" additivity="true"> <appender-ref ref="ERROR_FILE"/> </logger> <!-- 輸出info信息到文件--> <logger name="info" additivity="true"> <appender-ref ref="INFO_FILE"/> </logger> <!-- 輸出request信息到文件--> <logger name="request" level="INFO" additivity="false"> <appender-ref ref="REQUEST_FILE" /> </logger> <!-- 輸出SQL到控制檯和文件--> <logger name="org.hibernate.SQL" additivity="false"> <level value="DEBUG" /> <appender-ref ref="SQL_FILE" /> </logger> <!-- 輸出SQL的參數到控制檯和文件--> <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>
標籤說明：性能
<root>標籤，必填標籤，用來指定最基礎的日誌輸出級別
<appender-ref>標籤，添加append
<append>標籤，經過使用該標籤指定日誌的收集策略
<filter>標籤，經過使用該標籤指定過濾策略
<level>標籤指定過濾的類型
<encoder>標籤，使用該標籤下的<pattern>標籤指定日誌輸出格式
<rollingPolicy>標籤指定收集策略，好比基於時間進行收集
<fileNamePattern>標籤指定生成日誌保存地址，經過這樣配置已經實現了分類分日期收集日誌的目標了
name屬性指定appender命名
class屬性指定輸出策略，一般有兩種，控制檯輸出和文件輸出，文件輸出就是將日誌進行一個持久化
ConsoleAppender將日誌輸出到控制檯
部分截圖展現：
目錄：
error.log
info.log
sql.log
request.log
二、logback 高級特性異步輸出日誌
若是不配置異步輸出規則，那麼默認日誌配置方式是基於同步的，每第二天志輸出到文件都會進行一次磁盤IO。
採用異步寫日誌的方式而不讓這次寫日誌發生磁盤IO，阻塞線程從而形成沒必要要的性能損耗。
異步輸出日誌的方式很簡單，添加一個基於異步寫日誌的appender，並指向原先配置的appender便可。
異步輸出配置：
<!-- 異步輸出INFO_FILE --> <appender name="ASYNC_INFO_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="INFO_FILE"/> </appender> <!-- 異步輸出ERROR_FILE --> <appender name="ASYNC_ERROR_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="ERROR_FILE"/> </appender> <!-- 異步輸出SQL_FILE --> <appender name="ASYNC_SQL_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="SQL_FILE"/> </appender> <!-- 異步輸出REQUEST_FILE --> <appender name="ASYNC_REQUEST_FILE" class="ch.qos.logback.classic.AsyncAppender"> <!-- 更改默認的隊列的深度,該值會影響性能.默認值爲256 --> <queueSize>256</queueSize> <!-- 默認狀況下，當阻塞隊列的剩餘容量爲20％時，它將丟棄TRACE，DEBUG和INFO級別的事件，僅保留WARN和ERROR級別的事件。要保留全部事件，請將discardingThreshold設置爲0。 --> <discardingThreshold>0</discardingThreshold> <!-- 添加附加的appender,使用前面定義的name,最多隻能添加一個 --> <appender-ref ref="REQUEST_FILE"/> </appender>
參數配置：
| 參數名稱 | 參數類型 | 建議值 | 說明 |
| queueSize | int | queueSize計算 example：假設IO影響30s，日誌和qps比例是1:1，單容器壓測值1500 qps則能夠推算出queue size的值，queueSize的設置公式：30 ＊1500=45000。 |
阻塞隊列的最大容量。默認狀況下，queueSize設置爲256。 |
| discardingThreshold | int | 使用默認值20，或者設置大於0。 若是設置discardingThreshold＝0，表示queue 滿了，不丟棄，block線程。 |
默認狀況下，當阻塞隊列剩餘20%的容量時，它將丟棄級別跟蹤、調試和信息事件，只保留級別警告和錯誤事件。要保留全部事件，請將discardingThreshold設置爲0。 |
| neverBlock | boolean | true | 若是爲false（默認值），則追加程序將阻止追加到完整隊列，而不是丟失消息。設置爲true時，附加程序只會丟棄消息，不會阻止您的應用程序。 |
官方文檔連接：http://logback.qos.ch/manual/appenders.html#AsyncAppender
三、異步日誌輸出原理
異步輸出日誌中最關鍵的就是配置文件中ch.qos.logback.classic包下AsyncAppenderBase類中的append方法，查看該方法的源碼:
@Override protected void append(E eventObject) { if (isQueueBelowDiscardingThreshold() && isDiscardable(eventObject)) { return; } preprocess(eventObject); put(eventObject); }
經過隊列狀況判斷是否須要丟棄日誌，不丟棄的話將它放到阻塞隊列中，經過查看代碼，這個阻塞隊列爲queueSize，默認大小爲256，能夠經過配置文件進行修改。
/** * The default buffer size. */ public static final int DEFAULT_QUEUE_SIZE = 256; int queueSize = DEFAULT_QUEUE_SIZE;
Logger.info(...)到append(...)就結束了，只作了將日誌塞入到阻塞隊列的事，而後繼續執行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(); } }
從阻塞隊列中取出一個日誌，並調用AppenderAttachableImpl類中的appendLoopOnAppenders方法維護一個Append列表。
最主要的兩個方法就是encode和write方法，前一個法方會根據配置文件中encode指定的方式轉化爲字節碼，後一個方法將轉化成的字節碼寫入到文件中去。
因此寫文件是經過新起一個線程去完成的，主線程將日誌放到阻塞隊列中，而後又去執行其餘任務。