跳到主要內容

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

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php