跳到主要內容

在Log4j2設定TimeAndSizeRollingAppender

Introduction

在Log4j1中，可以引入支援TimeAndSizeRollingAppender的library去支援基於檔案大小+時間+檔案數量三個條件去滾動檔案。當到隔天的00:00時，我想產生新的log file就會使用到這種設定方式。本篇要分享在log4j2的設定方法。

TimeBasedTriggeringPolicy+Delete Action

在logj2中，提供了TimeBasedTriggeringPolicy讓你可以完成這個需求。然而，如果要做到最大檔案數量控制的話，則要多使用Delete action的特性。我首先說明與一般RollingFileAppender只有檔案大小與檔案數量設定的不同之處:

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.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個，接下來說明各屬性意義:

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.IfAccumulatedFileCount.type = IfAccumulatedFileCount
appender.logfile.strategy.action.ifFileName.IfAccumulatedFileCount.exceeds = 10

  • appender.logfile.strategy.action.type: 設定為Delete，代表要使用Delete Action。
  • appender.logfile.strategy.action.basepath: 要執行Delete動作開始掃描的路徑。
  • appender.logfile.strategy.action.maxDepth: 要掃描的資料夾深度，預設值為1，在這裡我也是指定為1。
  • appender.logfile.strategy.action.IfFileName.type: 要使用Delete Action必須要先宣告設定pathConditions或scriptCondition。以我們的需求來說，是要以檔案名稱當作條件，所以直接設定type為IfFileName。
  • appender.logfile.strategy.action.IfFileName.glob: 就著就是設定檔案名稱規則，在這使用了glob的pattern設定方式。也可以設定regex去支援regex expression的pattern。
  • appender.logfile.strategy.action.IfFileName.IfAccumulatedFileCount.type: 基於IfFileName的條件，多加了IfAccumulatedFileCount去限制檔案數量。
  • appender.logfile.strategy.action.IfFileName.IfAccumulatedFileCount.exceeds: 設定檔案數量不得超過10，超過就會執行刪除符合glob樣式的檔案。

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

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

Multiple Path Conditions

前面所提到的pathConditions，是可以支援多個條件的。以前面的例子來說，是設了一組nested的condition，假如改設定成多組會長這個樣子:

appender.logfile.strategy.action.ifFileName.type = IfFileName
appender.logfile.strategy.action.ifFileName.glob = log.txt*
appender.logfile.strategy.action.ifAccumulatedFileCount.type = IfAccumulatedFileCount
appender.logfile.strategy.action.ifAccumulatedFileCount.exceeds = 10

根據文件描述與目前實驗起來，上面的關係是屬於IfAll的關係。另外記錄一下，目前我們使用的log4j2版本為2.17.2，我發現當設定下面兩組properties時，雖然合理但其實沒有作用。第一組是把key從ifFileName改成IfFileName:

appender.logfile.strategy.action.IfFileName.type = IfFileName
appender.logfile.strategy.action.IfFileName.glob = log.txt*
appender.logfile.strategy.action.ifAccumulatedFileCount.type = IfAccumulatedFileCount
appender.logfile.strategy.action.ifAccumulatedFileCount.exceeds = 10

第二組是在最上層設定了IfAll是沒有作用的..

appender.logfile.strategy.action.ifAll.type = IfAll
appender.logfile.strategy.action.ifAll.ifFileName.type = IfFileName
appender.logfile.strategy.action.ifAll.ifFileName.glob = log.txt*
appender.logfile.strategy.action.ifAll.ifAccumulatedFileCount.type = IfAccumulatedFileCount
appender.logfile.strategy.action.ifAll.ifAccumulatedFileCount.exceeds = 10

這就不曉得log4j2是否存在某種潛規則了..

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後，Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護，我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情，主要先把明確的runtime語法錯誤與deprecate item處理好，這部分內容可以參考: link 。 直到最近才發現，透過SeleniumLibrary執行Choose File去上傳檔案的動作，會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法，我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住，有些測試案例是可以執行的，但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作，因為我使用 Remote Selenium ，所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現，在3.2.2的最後一個TCP封包，比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容，還有HTTP Content-Length的計算，我都確認過沒有問題。 最後發現問題是出在socket API的使用上，就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料，但沒處理到尚未送完的資料內容，而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方，在他們出新的版本之前，我是將改完的_socket.py放在我們自己的Lib底下，好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)
張貼留言
閱讀完整內容

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後，安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數，以前試驗過是可以安裝完成的。因此在發生這個問題後，我檢查了它的debug console: 從console得知，eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認，有問題的是有接網路線的網卡，且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制，因此發現在Anaconda的說明文件中( link )，有提到dhcptimeout這個boot參數。看了一些人的使用範例，應該是可以直接串在isolinux.cfg中，如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串，問問Google大師，想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ，關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中；在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知，它讀取的檔案是answer file而不是boot command line。因此我接下來的測試，就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...
張貼留言
閱讀完整內容

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用，經過一些查詢與試驗，我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字，也可以透過它們做四則運算。首先以字串轉數字為例，我將8設於${num_str}中，再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則，假如你設定的數字為08，在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base，這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex，可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說，第一個是2的3次方為8，第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min，可以選擇丟一個array的方式...
張貼留言
閱讀完整內容