一、log4j2配置詳解
項目裏使用了log4j2作爲日誌打印,但是log4j2和log4j相比配置文件有很大的差異,所以這裏記錄一下配置文件的說明
二、配置解析
1. 配置文件的名稱以及在項目中的位置
在查閱資料的時候看到有的博客寫的是log4j2的配置文件名是log4j2-spring.xml
,但是我測試了一下其實不寫這個也可以的。
log4j 2.x版本不支持已.properties
爲後綴的文件配置方式,2.x版本的配置文件後綴名只能爲:.xml,.json,.jsn
這三種。
系統選擇配置文件的優先級爲(優先級由高到低):
(1).classpath下的名爲log4j2-test.json 或者log4j2-test.jsn的文件.
(2).classpath下的名爲log4j2-test.xml的文件.
(3).classpath下名爲log4j2.json 或者log4j2.jsn的文件.
(4).classpath下名爲log4j2.xml的文件.
我自己是習慣寫log4j2.xml
,或者再加上log4j2-test.xml
這樣就可以測試環境用log4j2-test.xml
,正式環境用log4j2.xml
,只要在打包的時候忽略log4j2-test.xml
即可。
2. 默認配置文件樣式
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>
3. 配置文件節點解析
(1). 根節點Configuration
有兩個屬性:status
和monitorInterval
,有兩個子節點:Appenders
和Loggers
,這裏都帶着s
說明可以有多個子節點。
status:用來設置log4j2本身的日誌打印級別,也可以不設置,當設置爲trace
時,就可以看到所有級別的日誌
monitorInterval:用於指定log4j自動重新配置的監測時間,設置間隔爲秒數,默認爲5s
(2). Appenders節點,常見的有三種子節點:Console
,RollingFile
和File
-
Console節點用來定義輸出到控制檯的Appender
name:指定Appender的名字
target:指定輸出模式,一般是
SYSTEM_OUT
和SYSTEM_ERR
,默認爲前者。PatternLayout:輸出格式,不設置默認爲
%m%n
-
File節點用來定義輸出到指定位置的文件Appender
name:指定Appender的名字
filename:指定輸出日誌的目的文件帶全路徑的文件名
PatternLayout:輸出格式,不設置默認爲
%m%n
-
RollingFile節點用來定義超過指定文件大小自動刪除舊的創建新的Apender
name:指定Appender的名字
fileName:指定輸出日誌的目的文件帶全路徑的文件名
filePattern:指定新建日誌文件的名稱格式
PatternLayout:輸出格式,不設置默認爲
%m%n
Policies:指定滾動日誌的策略,例如當日志超過設定的日誌大小新建新的日誌文件
TimeBasedTriggeringPolicy:Policies子節點,基於時間的滾動策略,interval屬性用來指定多久滾動一次,默認是1hour。modulate=true用來調整時間:比如現在是早上3am,interval是4,那麼第一次滾動是在4am,接着是8am,12am…而不是7am
SizeBasedTriggeringPolicy:Policies子節點,基於指定文件大小的滾動策略,size屬性用來定義每個日誌文件的大小
DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日誌文件時開始刪除最舊的,創建新的(通過max屬 性)。
(3). Loggers節點,常見的有兩種:Root
和 Logger
-
Root節點用來指定項目的根日誌,如果沒有單獨指定Logger,呢麼就會使用該Root日誌輸出輸出
level:日誌輸出級別,共有8個級別
AppenderRef:Root的子節點,用來指定該日誌輸出到哪個Appender
-
Logger節點用來單獨指定日誌的形式,比如要爲指定包下的class指定不同的日誌級別
level:日誌輸出級別,共有8個級別
name:指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點
AppenderRef:Logger的子節點,用來指定該日誌輸出到哪個Appender,如果沒有指定,就會默認繼承自Root。如果指定了,就會在指定的Appender和Root的Appender中都會輸出,此時我們可以設置Logger的
additivity=false
只在自定義的Appender中輸出日誌。
4. 關於日誌level
共有8個級別,按照從低到高爲:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
All:最低等級的,用於打開所有日誌記錄.
Trace:是追蹤,就是程序推進以下,你就可以寫個trace輸出,所以trace應該會特別多,不過沒關係,我們可以設置最低日誌級別不讓他輸出.
Debug:指出細粒度信息事件對調試應用程序是非常有幫助的.
Info:消息在粗粒度級別上突出強調應用程序的運行過程.
Warn:輸出警告及warn以下級別的日誌.
Error:輸出錯誤信息日誌.
Fatal:輸出每個嚴重的錯誤事件將會導致應用程序的退出的日誌.
OFF:最高等級的,用於關閉所有日誌記錄.
程序會打印高於或等於所設置級別的日誌,設置的日誌等級越高,打印出來的日誌就越少。
5. 樣例模板:
<?xml version="1.0" encoding="UTF-8"?>
<!--日誌級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration後面的status,這個用於設置log4j2自身內部的信息輸出,可以不設置,當設置成trace時,你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval:Log4j能夠自動檢測修改配置 文件和重新配置本身,設置間隔秒數-->
<configuration status="WARN" monitorInterval="30">
<!-- 可以設置公共屬性 -->
<Properties>
<property name="logPath">/opt/logs</property>
<property name="charset">UTF-8</property>
<property name="pattern">[%d{yyyy-MM-dd HH:mm:ss.SSS}][%-5p] [%t] [%c{1}:%M %L] %m %n</property>
</Properties>
<!--先定義所有的appender-->
<appenders>
<!--這個輸出控制檯的配置-->
<console name="Console" target="SYSTEM_OUT">
<!--輸出日誌的格式 ${pattern}使用屬性變量-->
<PatternLayout pattern="${pattern}" charset="${charset}"/>
</console>
<!--文件會打印出所有信息,這個log每次運行程序會自動清空,由append屬性決定,這個也挺有用的,適合臨時測試用-->
<File name="log" fileName="${logPath}/log/test.log" append="false">
<PatternLayout pattern="${pattern}" charset="${charset}"/>
</File>
<!-- 這個會打印出所有的info及以下級別的信息,每次大小超過size,則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮,作爲存檔-->
<RollingFile name="RollingFileInfo" fileName="${logPath}/logs/info.log"
filePattern="${logPath}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制檯只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${pattern}" charset="${charset}"/>
<Policies>
<!-- 按天分割 -->
<TimeBasedTriggeringPolicy modulate="true" interval="1" />
<SizeBasedTriggeringPolicy size="100MB" />
</Policies>
<!-- max 最多20個文件 IfLastModified 保留日誌的天數 超過30天刪除舊的日誌 basePath 刪除目錄 maxDepth 搜索層數-->
<DefaultRolloverStrategy max="20">
<Delete basePath="${logPath}/logs/$${date:yyyy-MM}/" maxDepth="1">
<IfFileName glob="info-*.log" />
<IfLastModified age="30d" />
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
<RollingFile name="RollingFileWarn" fileName="${logPath}/logs/warn.log"
filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
<!--控制檯只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${pattern}" charset="${charset}"/>
<Policies>
<!-- 按天分割 -->
<TimeBasedTriggeringPolicy modulate="true" interval="1" />
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
<!-- DefaultRolloverStrategy屬性如不設置,則默認爲最多同一文件夾下7個文件,這裏設置了20 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${logPath}/logs/error.log"
filePattern="${logPath}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${pattern}" charset="${charset}"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
<!-- RollingFileXing日誌 com.gitee.xing-->
<RollingFile name="RollingFileXing" fileName="${logPath}/logs/xing.log"
filePattern="${logPath}/logs/$${date:yyyy-MM}/xing-%d{yyyy-MM-dd}-%i.log">
<PatternLayout pattern="${pattern}" charset="${charset}"/>
<Policies>
<TimeBasedTriggeringPolicy modulate="true" interval="1" /> <!-- 按天分割 -->
<SizeBasedTriggeringPolicy size="100MB" /> <!-- 按100MB分割 -->
</Policies>
<DefaultRolloverStrategy max="20">
<Delete basePath="${logPath}/logs/$${date:yyyy-MM}/" maxDepth="1">
<IfFileName glob="xing-*.log" />
<IfLastModified age="30d" />
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
</appenders>
<!--然後定義logger,只有定義了logger並引入的appender,appender纔會生效-->
<loggers>
<!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
<logger name="org.springframework" level="INFO"></logger>
<logger name="org.mybatis" level="INFO"></logger>
<!-- 設置Logger的additivity="false"只在自定義的Appender中進行輸出 -->
<Logger name="com.gitee.xing" additivity="false" level="INFO">
<appender-ref ref="audit" level="ALL" />
</Logger>
<root level="all">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>
參考文章:https://www.cnblogs.com/hafiz/p/6170702.html