logback:RollingFileAppender

RollingFileAppender :滾動記錄文件,先將日誌記錄到指定文件,當符合某個條件時,將日誌記錄到其餘文件

ps:
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true" scan="true" scanPeriod="1 seconds">

<contextName>webA</contextName>

<appender name="file" append="true" class="ch.qos.logback.core.rolling.RollingFileAppender">

<file>/logs/log_file.log</file>

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>/logs/log_file_%d{yyyy-mm-dd.HH}.log</fileNamePattern>
<maxHistory>30</maxHistory>

<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>

<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>100MB</maxFileSize>
</triggeringPolicy>

<encoder>
<pattern>%cn%d.%M.%m%n</pattern>
</encoder>
</appender>

<root level="debug">
<appender-ref ref="file"/>
</root>

</configuration>

主要節點:
(1)file文件名,可選。若沒有設定參考下面fileNamePattern名稱生成文件
(2)rollingPolicy當日志發生滾動時,決定日誌文件的行爲。決定文件的重命名及路徑的變動。必選
其中class屬性決定出發哪套行爲控制
fileNamePattern 滾動後產生的文件名規則
maxHistory日誌保留時長,30天。超過天數後刪除日誌文件,同時配套目錄一塊兒刪除。該參數不必定是指天數,也能夠是月份數。具體參考滾動規則fileNamePattern,看是依賴什麼進行滾動的
totalSizeCap最大日誌量
(3)triggeringPolicy 滾動觸發規則
maxFileSize單個文件最大量,若是達到這個最大量。日誌有可能會出現報錯,新日誌沒法存入。

--注意:%cn:獲取上下文名稱contextName。該用法是<encoder>標籤的屬性,只能在該標籤使用。其餘標籤不能使用
rollingPolicy、triggeringPolicy 有不一樣的class實現類,具體每一個實現類的用法及參數屬性會有所不一樣。使用時注意區分


 

fileNamePattern的介紹web

 

/wombat/foo.%d :
天天輪轉(晚上零點)。因爲省略了指定 %d 的日期格式,因此默認爲 yyyy-MM-dd。app

 

/wombat/%d{yyyy/MM}/foo.txt:
每月開始的時候輪轉。編碼

 

/wombat/foo.%d{yyyy-ww}.log:
每週的第一天(取決於時區)輪轉。spa

 

/wombat/foo%d{yyyy-MM-dd_HH}.log:
每小時輪轉。debug

 

/wombat/foo%d{yyyy-MM-dd_HH-mm}.log:
每分鐘輪轉。日誌

 

/wombat/foo%d{yyyy-MM-dd_HH-mm, UTC}.log:
每分鐘輪轉,時間格式爲UTC。code

 

/foo/%d{yyyy-MM, aux}/%d.log:
天天輪轉。歸檔文件在包含年月的文件夾下。xml

 

任何斜杆或者反斜槓夠會被看成文件夾分隔符。任何須要的文件夾都會在有須要的時候建立。能夠將日誌文件放在單獨的文件夾中。blog

 

TimeBasedRollingPolicy支持文件自動壓縮。若是 fileNamePattern以 .gz 或者 .zip結尾,將會啓動這個特性。索引

 

例如:/wombat/foo.%d.gz:天天輪轉(晚上零點),自動將歸檔文件壓縮成 GZIP 格式

 



RollingPolicy:TimeBasedRollingPolicy,SizeAndTimeBasedRollingPolicy,FixedWindowRollingPolicy
一、TimeBasedRollingPolicy 基於時間滾動
官方示例:

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logFile.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- daily rollover -->
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>

 

      <!-- keep 30 days' worth of history capped at 3GB total size -->
      <maxHistory>30</maxHistory>
      <totalSizeCap>3GB</totalSizeCap>

 

    </rollingPolicy>

 

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

 

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

二、SizeAndTimeBasedRollingPolicy 基於時間+大小進行滾動。是對於第一種的補充。避免單個日誌文件過大,不便於閱讀

<configuration>
  <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>mylog.txt</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <!-- rollover daily -->
      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
       <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
       <maxFileSize>100MB</maxFileSize>   
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%msg%n</pattern>
    </encoder>
  </appender>


  <root level="DEBUG">
    <appender-ref ref="ROLLING" />
  </root>

</configuration>

mylog-%d{yyyy-MM-dd}.%i.txt其中的%i表示一天內滾動生成多個日誌時的編碼

 

三、FixedWindowRollingPolicy 基於窗口滾動

能夠理解成自定義滾動規則,避免使用出現單個文件過大或者日誌文件過多的狀況。須要同時配置triggeringPolicy用於指定滾動觸發規則

 

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

輸出規則:越早生成名稱序號越靠後。minIndex、maxIndex最小索引最大索引





TriggeringPolicy用於通知什麼時候觸發滾動
實現類:SizeBasedTriggeringPolicy

SizeBasedTriggeringPolicy觀察當前活動文件的大小,若是已經大於了指定的值,它會給 RollingFileAppender 發一個信號觸發對當前活動文件的輪轉。

 

SizeBasedTriggeringPolicy 只接收 maxFileSize 這一個參數,它的默認值是 10 MB。

 

maxFileSize 能夠爲字節,千字節,兆字節,千兆字節,經過在數值後面指定一個後綴 KB,MB 或者 GB。例如,5000000,5000KB,5MB 以及 2GB 都是有效的,前三個是同樣的。

本站公眾號
   歡迎關注本站公眾號,獲取更多信息