日誌工具logback的簡介與配置

qingyezhu發表於2015-04-21
Logback是由log4j創始人設計的又一個開源日誌元件。logback當前分成三個模組:logback-core,logback- classic和logback-access。logback-core是其它兩個模組的基礎模組。logback-classic是log4j的一個 改良版本。此外logback-classic完整實現SLF4J API使你可以很方便地更換成其它日誌系統如log4j或JDK14 Logging。logback-access訪問模組與Servlet容器整合提供通過Http來訪問日誌的功能。
 
 
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>${spring.version}</version>
    <exclusions>
       <exclusion>
          <groupId>commons-logging</groupId>
          <artifactId>commons-logging</artifactId>
       </exclusion>
    </exclusions>            
</dependency>
 
 <!-- logback -->
  <dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-core</artifactId>
   <version>${logback.version}</version>
  </dependency>
  <dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-classic</artifactId>
   <version>${logback.version}</version>
  </dependency>
  <dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-access</artifactId>
   <version>${logback.version}</version>
  </dependency>
 
  <!-- Logging -->
  <dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-api</artifactId>
   <version>${org.slf4j.version}</version>
  </dependency>
  <dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>jcl-over-slf4j</artifactId>
   <version>${org.slf4j.version}</version>
   <scope>runtime</scope>
  </dependency>
 
 
1、
 scan: 當此屬性設定為true時,配置檔案如果發生改變,將會被重新載入,預設值為true。 
 
scanPeriod: 設定監測配置檔案是否有修改的時間間隔,如果沒有給出時間單位,預設單位是毫秒。當scan為true時,此屬性生效。預設的時間間隔為1分鐘。 
 
debug: 當此屬性設定為true時,將列印出logback內部日誌資訊,實時檢視logback執行狀態。預設值為false。 
 
例如:
 
    <configuration scan="true" scanPeriod="60 seconds" debug="false">  
          <!-- 省略-->  
    </configuration>  
 
2、 <loger> 
用來設定某一個包或者具體的某一個類的日誌列印級別、以及指定<appender>。<loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。 
 
name: 用來指定受此loger約束的某一個包或者具體的某一個類。 
 
level: 用來設定列印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。 
 
如果未設定此屬性,那麼當前loger將會繼承上級的級別。
 
addtivity:是否向上級loger傳遞列印資訊。預設是true。 
 
<loger>可以包含零個或多個<appender-ref>元素,標識這個appender將會新增到這個loger。
  
 
3、<root>
也是<loger>元素,但是它是根loger。只有一個level屬性,應為已經被命名為"root". 
 
level: 用來設定列印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設定為INHERITED或者同義詞NULL。 
預設是DEBUG。 
 
<root>可以包含零個或多個<appender-ref>元素,標識這個appender將會新增到這個loger。
 
4、 <appender>: 
 
<appender>是<configuration>的子節點,是負責寫日誌的元件。
 
<appender>有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名。
 
 
1)、ConsoleAppender:
 
把日誌新增到控制檯,有以下子節點:
 
<encoder>:對日誌進行格式化。(具體引數稍後講解 )
 
<target>:字串 System.out 或者 System.err ,預設 System.out ;
 
2)、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。
 
 
例子:
 
1、每天生成一個日誌檔案,儲存30天的日誌檔案。
 
 <configuration>  
  <appender name="savefile" 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="info">  
    <appender-ref ref="savefile" />  
  </root>  
</configuration> 
 
每小時產生一個日誌檔案,並儲存在當天的日誌資料夾中
 
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>
                logs/%d{yyyy-MM-dd,aux}/%d{yyyy-MM-dd-hh}.log
        </fileNamePattern>
        <maxHistory>60</maxHistory>
</rollingPolicy>
 
參考文件:
 
2、按照固定視窗模式生成日誌檔案,當檔案大於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>  
 
 
參考資料:
 
 
 

相關文章