差異處

這裏顯示兩個版本的差異處。

連向這個比對檢視

Both sides previous revision 前次修改
下次修改
前次修改
java:log4j2:indicateconfigurationfile [2022/04/10 10:13]
tony
java:log4j2:indicateconfigurationfile [2023/06/25 09:48] (目前版本)
行 5: 行 5:
 ===== How to? ===== ===== How to? =====
 ==== 指定設定檔 ==== ==== 指定設定檔 ====
-log4j2能接受的指定方式包含了log4j2.configurationFile與log4j.configurationFile兩種。假設設定檔log4j2-app.properties放置於工作目錄的config資料夾內,我的windows設定會如下方這樣,%BASE%是在script中會設定工作目錄的變數:​+log4j2能接受的指定方式包含了log4j2.configurationFile與log4j.configurationFile兩種,如果有多個檔案要用逗號分隔。假設設定檔log4j2-app.properties放置於工作目錄的config資料夾內,我的windows設定會如下方這樣,%BASE%是在script中會設定工作目錄的變數:​
 <code bash> <code bash>
 java %CLASSPATH% -Dlog4j2.configurationFile="​%BASE%/​config/​log4j2-app.properties"​ org.tonylin.practice.App %* java %CLASSPATH% -Dlog4j2.configurationFile="​%BASE%/​config/​log4j2-app.properties"​ org.tonylin.practice.App %*
行 17: 行 17:
 -Dlog4j2.configurationFile="​file:​C:/​Program%%20Files/​App/​config/​log4j2-app.properties"​ -Dlog4j2.configurationFile="​file:​C:/​Program%%20Files/​App/​config/​log4j2-app.properties"​
 </​code>​ </​code>​
-如上面範例,batch script要額外加上%去跳脫才能正常輸入,否則會把%2當成輸入參數。回歸正題,如果不需要加file prefix的話,我想沒有人會想自己把問題變困難吧?​+如上面範例,batch script要額外加上%去跳脫才能正常輸入,否則會把%2當成輸入參數。回歸正題,如果不需要加file prefix的話,我想沒有人會想自己把問題變困難吧? ​置於file的問題是不是log4j2沒處理好空白的問題,我就沒深究了。
 ==== 出問題如何debug?​ ==== ==== 出問題如何debug?​ ====
 在發生檔案找不到的問題時,可以加上以下參數:​ 在發生檔案找不到的問題時,可以加上以下參數:​
行 30: 行 30:
  
 ==== 指定log產生位置 ==== ==== 指定log產生位置 ====
 +通常application啟動時,都會特別指定工作目錄,而log通常產生於工作目錄下。如果符合這個情境,在設定RollingFile產生檔案位置時,可以採用相對路徑的方式去設定:​
 +<code properties>​
 +appender.logfile.type = RollingFile
 +appender.logfile.name = LOGFILE
 +appender.logfile.fileName = ./​syslog/​log.txt
 +appender.logfile.filePattern = ./​syslog/​log.txt.%i
 +</​code>​
 +假如你是執行一個腳本,工作目錄取決於使用者但你又希望log要產生在應用程式或script的安裝目錄下的話,你可能有幾個選擇:​
 +  - 在lo4j2設定檔案中,直接指定應用程式安裝或script目錄位置。
 +  - 在script中直接取得檔案位置,並透過system properties形式傳遞給log4j2的設定檔案。
 +第一個方法需要安裝程式的配合,我分享第二個方法給大家。首先要先知道當前目錄的絕對路徑,以windows batch來說,可這樣做:​ (linux請參考[[linux:​sell_script:​replacefiles|link]])
 +<code bash>
 +set BASE=%~dp0
 +</​code>​
 +接著就是把路徑設定到system properties中,變數名稱為path.base。這裡可以發現%BASE%後還加了句點,原因是windows拿到的路徑結尾是\,這會導致讓雙引號被跳脫,所以透過句點去避掉這個問題:​
 +<code bash>
 +-Dpath.base="​%BASE%."​
 +</​code>​
 +最後就是引入設定檔了,
 +<code properties>​
 +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
 +</​code>​
 +這裡做了一些重構,將共用的const抽為property宣告。另外與log4j1不同的是,log4j2支援許多prefix,去避免properties名稱的衝突問題。以我們的例子來說,我們使用的是system properties的path.base,所以變數名稱就要叫${sys:​path.base};假如你要引入系統環境變數,就會是${env:​path.base},更多可以參考[[https://​logging.apache.org/​log4j/​2.x/​manual/​configuration.html#​PropertySubstitution|link]]。對了,它支援default value: ${sys:​some.property:​-default_value}。
  
 ==== 設定檔搜尋規則 ==== ==== 設定檔搜尋規則 ====
- +根據[[https://​logging.apache.org/​log4j/​2.x/​manual/​configuration.html#​AutomaticConfiguration|link]]描述,設定檔的搜尋規則與順序如下:​ 
 +  - 找log4j2.configurationFile所設定的檔案位置。 
 +  - 找檔案名稱為log4j2-test.properties的設定檔。根據不同格式的支援,順序為YAML>​JSON>​XML>​properties。 
 +  - 找檔案名稱為log4j2.properties的設定檔。根據不同格式的支援,順序為YAML>​JSON>​XML>​properties。 
 +  - 如果都找不到就是看log4j的預設值了。目前是ERROR Level+Console。 
 +這也是為什麼如果test code和production code都有設定檔時會先找到test code部分的原因。
  
 ===== Reference ===== ===== Reference =====
-  * [[https://​logging.apache.org/​log4j/​2.x/​manual/​configuration.html#​Automatic%20Configuratio|官方網站檔案設定介紹]]+  * [[https://​logging.apache.org/​log4j/​2.x/​manual/​configuration.html#​AutomaticConfiguratio|官方網站檔案設定介紹]] 
 +  * [[https://​stackoverflow.com/​questions/​7126709/​how-do-i-set-log4j-level-on-the-command-line|How do I set log4j level on the command line?]]
 =====    ===== =====    =====
 ---- ----
 \\ \\
 ~~DISQUS~~ ~~DISQUS~~