這是本文件的舊版！

Log4j2 Appenders

Introduction

曾經在hello world中有提及，appender的設定算是設定檔中，最核心的部分，也是最複雜的。本篇文章用來記錄有使用過的Appender相關設定。

ConsoleAppender

這是最基本的appender，設定範例如下: 

appender.console.type = Console
appender.console.name = CONSOLE
appender.console.target = SYSTEM_OUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %d{HH:mm:ss} %5p[%t] (%F:%M:%L) - %m%n
appender.console.filter.threshold.type = ThresholdFilter
appender.console.filter.threshold.level = TRACE
在先前文章沒提到的是target設定，是用來決定console輸出的目標，預設為SYSTEM_OUT對應到System.out。如果要改成System.err，就要設定為SYSTEM_ERR。Note. log4j1設定為System.out或System.err。

RollingFileAppender with Size and File Count conditions

RollingFileAppender也是常用的appender之一，這裡是針對有單一檔案大小與檔案數量限制的範例。檔案大小限制為8000KB，而檔案最大的index為3，顧名思義會有四個檔案: log.txt、log.txt.1、log.txt.2與、log.txt.3。 

appender.logfile.type = RollingFile
appender.logfile.name = LOGFILE
appender.logfile.fileName = ./syslog/log.txt
appender.logfile.filePattern = ./syslog/log.txt.%i
appender.logfile.append = true
appender.logfile.layout.type = PatternLayout
appender.logfile.layout.pattern = %d{yyyy/MM/dd HH:mm:ss.SSS} %5p[%t] (%F:%M:%L) - %m%n
appender.logfile.policies.type = Policies
appender.logfile.policies.size.type = SizeBasedTriggeringPolicy
appender.logfile.policies.size.size = 8000KB
appender.logfile.strategy.type = DefaultRolloverStrategy
appender.logfile.strategy.fileIndex = fixed window
appender.logfile.strategy.max = 3
接下來針對較特別的項目做說明:

  • appender.logfile.fileName: log的檔案名稱。
  • appender.logfile.filePattern: 滿足單一檔案大小條件後，檔案名稱規則。你可以用日期去編，也可以只單純使用%i去表示index。index越大距離現在時間越遠。
  • appender.logfile.policies.size.type: 在這使用了SizeBasedTriggeringPolicy。
  • appender.logfile.policies.size.size: 在這指定了檔案大小限制為8000KB，還可以設定MB、GB或TB。這邊兩個size很像bug，如果你喜歡你也可以把它改成fuck.type與fuck.size，它只是一個區別trigger policy key的名稱。
  • appender.logfile.strategy.type: 用來指定rolling的規則，我們使用了DefaultRolloverStrategy，需與接下來的fileIndex還有max搭配。
  • appender.logfile.strategy.fileIndex: 我們使用fixed window的規則讓index最大只會到max。你也可以使用nomax不去限制最大index。
  • appender.logfile.strategy.max: 即index最大值設定。有max就會有min，min是用來指定最小index，如果你不喜歡從1-3，喜歡從2-3的話，那min就設2。

RollingFileAppender with Size, Time and File Count conditions

這個是基於前一種RollingFileAppender多增加以時間為滾動條件的設定方式。舉例來說，當到隔天的00:00時，我想產生新的log file就會用到這個條件。在log4j1時，要做到這個需求，需要引入另外一個支援TimeAndSizeRollingAppender的library；而在logj2中，則可直接透過TimeBasedTriggeringPolicy做到這個需求。除此之外，如果要做到最大檔案數量控制的話，要多使用Delete action的特性: 

appender.logfile.type = RollingFile
appender.logfile.name = LOGFILE
appender.logfile.fileName = ./syslog/log.txt
appender.logfile.filePattern = ./syslog/log.txt.%d{yyyy-MM-dd}.%i
appender.logfile.layout.type = PatternLayout
appender.logfile.layout.pattern = %d{yyyy/MM/dd HH:mm:ss.SSS} %5p[%t] (%F:%M:%L) - %m%n
appender.logfile.policies.type = Policies
appender.logfile.policies.size.type = SizeBasedTriggeringPolicy
appender.logfile.policies.size.size=8000KB
appender.logfile.policies.time.type = TimeBasedTriggeringPolicy
appender.logfile.policies.time.interval = 1
appender.logfile.policies.time.modulate = true
appender.logfile.strategy.type = DefaultRolloverStrategy
appender.logfile.strategy.fileIndex = nomax
appender.logfile.strategy.action.type = Delete
appender.logfile.strategy.action.basepath = ./syslog/
appender.logfile.strategy.action.maxDepth = 1
appender.logfile.strategy.action.ifFileName.type = IfFileName
appender.logfile.strategy.action.ifFileName.glob = log.txt*
appender.logfile.strategy.action.ifFileName.ifAny.type = IfAny
appender.logfile.strategy.action.ifFileName.ifAny.IfAccumulatedFileCount.type = IfAccumulatedFileCount
appender.logfile.strategy.action.ifFileName.ifAny.IfAccumulatedFileCount.exceeds = 10

  • appender.logfile.policies.time.type: 在這使用了TimeBasedTriggeringPolicy。key中的time也是用來區別key而已，你喜歡也可以取你愛的名字。
  • appender.logfile.policies.time.interval: 滾動的間隔，需與filePattern搭配。
  • appender.logfile.policies.time.modulate: 簡單來說如果你間隔是以天為單位的話，設定為true它就會幫你從00:00開始加interval；設定為false就看你程式何時執行了..
  • appender.logfile.filePattern: 檔案名稱需要加上時間格式，以控制滾動規則。需與TimeBasedTriggeringPolicy的interval與modulate搭配。以範例來說，就是每天的00:00會滾動log一次，將前一天的log.txt變為log.txt.2022-04-10.%i。
  • appender.logfile.strategy.fileIndex: 這裡我就沒套用max index，我把檔案最大數量的控制，交給了Delete Action。

Delete Action的設定比較彈性，可以根據目錄規則、檔案名稱、修改時間、檔案數量等等去定義刪除條件，詳情可以參考link。以範例來說，我希望能做到的是: 確保syslog下的log.txt*檔案不超過10個，接下來說明各屬性意義:

  • (To be contiune..)

Note. 如果你要快速測試TimeBasedTriggeringPolicy設定檔是否正確，可以把size限制調小，並且filePattern改為以下內容，它會以每分鐘的方式去滾動，而不需要等到天: 

appender.logfile.filePattern = ./syslog/log.txt.%d{yyyy-MM-dd-HH-mm}.%i

Reference