logback Appender详解
為什么80%的碼農(nóng)都做不了架構(gòu)師?>>> ??
一、簡介
<appender>是<configuration>的子節(jié)點,是負責(zé)寫日志的組件。
<appender>有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名。
?二、Appender分類
2.1 ConsoleAppender
把日志添加到控制臺,有以下子節(jié)點:
<encoder>:對日志進行格式化。(具體參數(shù)稍后講解?)
<target>:字符串?System.out?或者?System.err?,默認?System.out?;
<configuration>??<appender?name="STDOUT"?class="ch.qos.logback.core.ConsoleAppender">??<encoder>??<pattern>%-4relative?[%thread]?%-5level?%logger{35}?-?%msg?%n</pattern>??</encoder>??</appender>??<root?level="DEBUG">??<appender-ref?ref="STDOUT"?/>??</root>?? </configuration>2.2 FileAppender
把日志添加到文件,有以下子節(jié)點:
<file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認值。
<append>:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認是true。
<encoder>:對記錄事件進行格式化。(具體參數(shù)稍后講解?)
<prudent>:如果是 true,日志會被安全的寫入文件,即使其他的FileAppender也在向此文件做寫入操作,效率低,默認是 false。
例如:
<configuration>??<appender?name="FILE"?class="ch.qos.logback.core.FileAppender">??<file>testFile.log</file>??<append>true</append>??<encoder>??<pattern>%-4relative?[%thread]?%-5level?%logger{35}?-?%msg%n</pattern>??</encoder>??</appender>??<root?level="DEBUG">??<appender-ref?ref="FILE"?/>??</root>?? </configuration>2.3 RollingFileAppender:
滾動記錄文件,先將日志記錄到指定文件,當(dāng)符合某個條件時,將日志記錄到其他文件。有以下子節(jié)點:
<file>:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認值。
<append>:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認是true。
<encoder>:對記錄事件進行格式化。(具體參數(shù)稍后講解?)
<rollingPolicy>:當(dāng)發(fā)生滾動時,決定?RollingFileAppender?的行為,涉及文件移動和重命名。
<triggeringPolicy?>:?告知?RollingFileAppender?合適激活滾動。
<prudent>:當(dāng)為true時,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個限制,1不支持也不允許文件壓縮,2不能設(shè)置file屬性,必須留空。
?
rollingPolicy:
?
TimeBasedRollingPolicy:?最常用的滾動策略,它根據(jù)時間來制定滾動策略,既負責(zé)滾動也負責(zé)觸發(fā)滾動。有以下子節(jié)點:
<fileNamePattern>:
必要節(jié)點,包含文件名及“%d”轉(zhuǎn)換符,?“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用 %d,默認格式是 yyyy-MM-dd。RollingFileAppender?的file字節(jié)點可有可無,通過設(shè)置file,可以為活動文件和歸檔文件指定不同位置,當(dāng)前日志總是記錄到file指定的文件(活動文件),活動文件的名字不會改變;如果沒設(shè)置file,活動文件的名字會根據(jù)fileNamePattern?的值,每隔一段時間改變一次?!?”或者“\”會被當(dāng)做目錄分隔符。
?
<maxHistory>:
可選節(jié)點,控制保留的歸檔文件的最大數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每個月滾動,且<maxHistory>是6,則只保存最近6個月的文件,刪除之前的舊文件。注意,刪除舊文件是,那些為了歸檔而創(chuàng)建的目錄也會被刪除。
?
?
FixedWindowRollingPolicy:?根據(jù)固定窗口算法重命名文件的滾動策略。有以下子節(jié)點:
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值,當(dāng)用戶指定的窗口過大時,會自動將窗口設(shè)置為12。
<fileNamePattern?>:
必須包含“%i”例如,假設(shè)最小值和最大值分別為1和2,命名模式為 mylog%i.log,會產(chǎn)生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項,例如,mylog%i.log.gz 或者 沒有l(wèi)og%i.log.zip
?
triggeringPolicy:
?
SizeBasedTriggeringPolicy:?查看當(dāng)前活動文件的大小,如果超過指定大小會告知RollingFileAppender?觸發(fā)當(dāng)前活動文件滾動。只有一個節(jié)點:
<maxFileSize>:這是活動文件的大小,默認值是10MB。
例如:每天生成一個日志文件,保存30天的日志文件。
<configuration>???<appender?name="FILE"?class="ch.qos.logback.core.rolling.RollingFileAppender">???<rollingPolicy?class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">???<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>???<maxHistory>30</maxHistory>????</rollingPolicy>???<encoder>???<pattern>%-4relative?[%thread]?%-5level?%logger{35}?-?%msg%n</pattern>???</encoder>???</appender>????<root?level="DEBUG">???<appender-ref?ref="FILE"?/>???</root>??? </configuration>? 例如:按照固定窗口模式生成日志文件,當(dāng)文件大于20MB時,生成新的日志文件。窗口大小是1到3,當(dāng)保存了3個歸檔文件后,將覆蓋最早的日志。
<configuration>???<appender?name="FILE"?class="ch.qos.logback.core.rolling.RollingFileAppender">???<file>test.log</file>???<rollingPolicy?class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">???<fileNamePattern>tests.%i.log.zip</fileNamePattern>???<minIndex>1</minIndex>???<maxIndex>3</maxIndex>???</rollingPolicy>???<triggeringPolicy?class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">???<maxFileSize>5MB</maxFileSize>???</triggeringPolicy>???<encoder>???<pattern>%-4relative?[%thread]?%-5level?%logger{35}?-?%msg%n</pattern>???</encoder>???</appender>???<root?level="DEBUG">???<appender-ref?ref="FILE"?/>???</root>??? </configuration>
2.4 ?其他
另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,這些就不在這里講解了,大家可以參考官方文檔。當(dāng)然大家可以編寫自己的Appender。
轉(zhuǎn)載于:https://my.oschina.net/hcliu/blog/546182
總結(jié)
以上是生活随笔為你收集整理的logback Appender详解的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 老李分享:Web Services 组件
- 下一篇: 加速进军自动驾驶领域,福特计划推出自动驾