logback 配置詳解(下)

logback 經常使用配置詳解（二） <appender>

 

<appender>：

<appender>是<configuration>的子節點，是負責寫日誌的組件。

<appender>有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名。

 

1.ConsoleAppender:

把日誌添加到控制檯，有如下子節點：

<encoder>：對日誌進行格式化。（具體參數稍後講解 ）

<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.FileAppender:

把日誌添加到文件，有如下子節點：

<file>：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。

<append>：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。

<encoder>：對記錄事件進行格式化。（具體參數稍後講解 ）

<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>

 

3.RollingFileAppender:

滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其餘文件。有如下子節點：

<file>：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。

<append>：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。

<encoder>：對記錄事件進行格式化。（具體參數稍後講解 ）

<rollingPolicy>:當發生滾動時，決定 RollingFileAppender 的行爲，涉及文件移動和重命名。

<triggeringPolicy >: 告知 RollingFileAppender 合適激活滾動。

<prudent>：當爲true時，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，可是有兩個限制，1不支持也不容許文件壓縮，2不能設置file屬性，必須留空。

 

rollingPolicy：

 

TimeBasedRollingPolicy： 最經常使用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。有如下子節點：

<fileNamePattern>:

必要節點，包含文件名及「%d」轉換符， 「%d」能夠包含一個Java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。若是直接使用 %d，默認格式是 yyyy-MM-dd。RollingFileAppender 的file字節點無關緊要，經過設置file，能夠爲活動文件和歸檔文件指定不一樣位置，當前日誌老是記錄到file指定的文件（活動文件），活動文件的名字不會改變；若是沒設置file，活動文件的名字會根據fileNamePattern 的值，每隔一段時間改變一次。「/」或者「\」會被當作目錄分隔符。

 

<maxHistory>:

可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。假設設置每月滾動，且<maxHistory>是6，則只保存最近6個月的文件，刪除以前的舊文件。注意，刪除舊文件是，那些爲了歸檔而建立的目錄也會被刪除。

 

 

FixedWindowRollingPolicy： 根據固定窗口算法重命名文件的滾動策略。有如下子節點：

<minIndex>:窗口索引最小值

<maxIndex>:窗口索引最大值，當用戶指定的窗口過大時，會自動將窗口設置爲12。

<fileNamePattern >:

必須包含「%i」例如，假設最小值和最大值分別爲1和2，命名模式爲 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還能夠指定文件壓縮選項，例如，mylog%i.log.gz 或者 沒有log%i.log.zip

 

 

triggeringPolicy:

 

SizeBasedTriggeringPolicy： 查看當前活動文件的大小，若是超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動。只有一個節點:

<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>

 

  例如：按照固定窗口模式生成日誌文件，當文件大於20MB時，生成新的日誌文件。窗口大小是1到3，當保存了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>

 

4.另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，並不經常使用，這些就不在這裏講解了，你們能夠參考官方文檔。固然你們能夠編寫本身的Appender。

 

 

<encoder>：

負責兩件事，一是把日誌信息轉換成字節數組，二是把字節數組寫入到輸出流。

目前PatternLayoutEncoder 是惟一有用的且默認的encoder ，有一個<pattern>節點，用來設置日誌的輸入格式。使用「%」加「轉換符」方式，若是要輸出「%」，則必須用「\」對「\%」進行轉義。

例如：

<encoder>
   <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder

 

<pattern>裏面的轉換符說明：

 

轉換符	做用
c {length }  lo {length }  logger {length }	輸出日誌的logger名，可有一個整形參數，功能是縮短logger名，設置爲0表示只輸入logger最右邊點符號以後的字符串。 Conversion specifier Logger name Result %logger mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar %logger{0} mainPackage.sub.sample.Bar Bar %logger{5} mainPackage.sub.sample.Bar m.s.s.Bar %logger{10} mainPackage.sub.sample.Bar m.s.s.Bar %logger{15} mainPackage.sub.sample.Bar m.s.sample.Bar %logger{16} mainPackage.sub.sample.Bar m.sub.sample.Bar %logger{26} mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar
C {length }  class {length }	輸出執行記錄請求的調用者的全限定名。參數與上面的同樣。儘可能避免使用，除非執行速度不形成任何問題。
contextName  cn	輸出上下文名稱。
d {pattern }  date {pattern }	輸出日誌的打印日誌，模式語法與java.text.SimpleDateFormat 兼容。 Conversion Pattern Result %d 2006-10-20 14:06:49,812 %date 2006-10-20 14:06:49,812 %date{ISO8601} 2006-10-20 14:06:49,812 %date{HH:mm:ss.SSS} 14:06:49.812 %date{dd MMM yyyy ;HH:mm:ss.SSS} 20 oct. 2006;14:06:49.812
F / file	輸出執行記錄請求的java源文件名。儘可能避免使用，除非執行速度不形成任何問題。
caller{depth}caller{depth, evaluator-1, ... evaluator-n}	輸出生成日誌的調用者的位置信息，整數選項表示輸出信息深度。 例如， %caller{2}   輸出爲： 0 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17) 例如， %caller{3}   輸出爲： 16 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17) Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38)
L / line	輸出執行日誌請求的行號。儘可能避免使用，除非執行速度不形成任何問題。
m / msg / message	輸出應用程序提供的信息。
M / method	輸出執行日誌請求的方法名。儘可能避免使用，除非執行速度不形成任何問題。
n	輸出平臺先關的分行符「\n」或者「\r\n」。
p / le / level	輸出日誌級別。
r / relative	輸出從程序啓動到建立日誌記錄的時間，單位是毫秒
t / thread	輸出產生日誌的線程名。
replace(p ){r, t}	p 爲日誌內容，r 是正則表達式，將p 中符合r 的內容替換爲t 。 例如， "%replace(%msg){'\s', ''}"

 

 

格式修飾符，與轉換符共同使用：

可選的格式修飾符位於「%」和轉換符之間。

第一個可選修飾符是左對齊 標誌，符號是減號「-」；接着是可選的最小寬度 修飾符，用十進制數表示。若是字符小於最小寬度，則左填充或右填充，默認是左填充（即右對齊），填充符爲空格。若是字符大於最小寬度，字符永遠不會被截斷。最大寬度 修飾符，符號是點號"."後面加十進制數。若是字符大於最大寬度，則從前面截斷。點符號「.」後面加減號「-」在加數字，表示從尾部截斷。

 

 

例如：%-4relative 表示，將輸出從程序啓動到建立日誌記錄的時間 進行左對齊 且最小寬度爲4。