跳到主要內容

Indicate Log4j2 Configuration File

Problem

在使用IDE開發時，類似log4j1通常只要將設定檔放在classpath中，並且檔名為log4j2-test.properties或log4j2.properties，在編譯後就可以享用log功能。然而，在軟體發布並安裝到使用者系統時，設定檔並不完完全全會依照這個規則放置或命名，你很有可能會有不同的應用程式使用不同設定檔的需求。本篇文章主要分享要解決這個問題的設定方法。

How to?

指定設定檔

log4j2能接受的指定方式包含了log4j2.configurationFile與log4j.configurationFile兩種，如果有多個檔案要用逗號分隔。假設設定檔log4j2-app.properties放置於工作目錄的config資料夾內，我的windows設定會如下方這樣，%BASE%是在script中會設定工作目錄的變數:

java %CLASSPATH% -Dlog4j2.configurationFile="%BASE%/config/log4j2-app.properties" org.tonylin.practice.App %*

這邊需要特別注意的是，在log4j1時，我們設定會使用到file:

-Dlog4j.configuration="file:%BASE%/config/log4j-app.properties"

但在logj2使用file的prefix時，就發生了檔案找不到的問題。後來發現root cause是%BASE%中包含空白字元而導致找不到檔案的問題，要解決這個問題你的空白字元就要以URL規則去encode:

-Dlog4j2.configurationFile="file:C:/Program%%20Files/App/config/log4j2-app.properties"

如上面範例，batch script要額外加上%去跳脫才能正常輸入，否則會把%2當成輸入參數。回歸正題，如果不需要加file prefix的話，我想沒有人會想自己把問題變困難吧? 置於file的問題是不是log4j2沒處理好空白的問題，我就沒深究了。

出問題如何debug?

在發生檔案找不到的問題時，可以加上以下參數:

-Dlog4j2.debug=true

在我自行加上%20後，可以從log發現空白變成0的問題，就查覺到是沒做%跳脫的問題:

java.io.FileNotFoundException: file:C:\Program0Files\App\config\log4j2-app.properties (The filename, directory name, or volume label syntax is
incorrect)

指定log產生位置

通常application啟動時，都會特別指定工作目錄，而log通常產生於工作目錄下。如果符合這個情境，在設定RollingFile產生檔案位置時，可以採用相對路徑的方式去設定:

appender.logfile.type = RollingFile
appender.logfile.name = LOGFILE
appender.logfile.fileName = ./syslog/log.txt
appender.logfile.filePattern = ./syslog/log.txt.%i

假如你是執行一個腳本，工作目錄取決於使用者但你又希望log要產生在應用程式或script的安裝目錄下的話，你可能有幾個選擇:

  1. 在lo4j2設定檔案中，直接指定應用程式安裝或script目錄位置。
  2. 在script中直接取得檔案位置，並透過system properties形式傳遞給log4j2的設定檔案。

第一個方法需要安裝程式的配合，我分享第二個方法給大家。首先要先知道當前目錄的絕對路徑，以windows batch來說，可這樣做: (linux請參考link)

set BASE=%~dp0

接著就是把路徑設定到system properties中，變數名稱為path.base。這裡可以發現%BASE%後還加了句點，原因是windows拿到的路徑結尾是\，這會導致讓雙引號被跳脫，所以透過句點去避掉這個問題:

-Dpath.base="%BASE%."

最後就是引入設定檔了，

property.basePath = ${sys:path.base}/syslog
property.appLog = log.txt
 
appender.logfile.type = RollingFile
appender.logfile.name = LOGFILE
appender.logfile.fileName = ${basePath}/${appLog}
appender.logfile.filePattern = ${basePath}/${appLog}.%i

這裡做了一些重構，將共用的const抽為property宣告。另外與log4j1不同的是，log4j2支援許多prefix，去避免properties名稱的衝突問題。以我們的例子來說，我們使用的是system properties的path.base，所以變數名稱就要叫${sys:path.base}；假如你要引入系統環境變數，就會是${env:path.base}，更多可以參考link。對了，它支援default value: ${sys:some.property:-default_value}。

設定檔搜尋規則

根據link描述，設定檔的搜尋規則與順序如下:

  1. 找log4j2.configurationFile所設定的檔案位置。
  2. 找檔案名稱為log4j2-test.properties的設定檔。根據不同格式的支援，順序為YAML>JSON>XML>properties。
  3. 找檔案名稱為log4j2.properties的設定檔。根據不同格式的支援，順序為YAML>JSON>XML>properties。
  4. 如果都找不到就是看log4j的預設值了。目前是ERROR Level+Console。

這也是為什麼如果test code和production code都有設定檔時會先找到test code部分的原因。

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的方式...
張貼留言
閱讀完整內容