1. 程式人生 > >日誌相關---log4j2配置檔案詳解

日誌相關---log4j2配置檔案詳解

一、關於配置檔案的名稱以及在專案中的存放位置

log4j 2.x版本不再支援像1.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放到classpath,而正式環境使用log4j2.xml,則在打包部署的時候不要打包log4j2-test.xml即可。

二、java專案中Classpath路徑到底指的是哪裡?

  • 1.src不是classpath,WEB-INF/classes,lib才是classpath,WEB-INF/是資源目錄, 客戶端不能直接訪問。

  • 2.WEB-INF/classes目錄存放src目錄java檔案編譯之後的class檔案,xml、properties等資源配置檔案,這是一個定位資源的入口。

  • 3.lib和classes同屬classpath,兩者的訪問優先順序為: lib>classes。

三、配置檔案節點解析

(1).根節點Configuration

Configuration有兩個屬性:status和monitorinterval,有兩個子節點:Appenders和Loggers(表明可以定義多個Appender和Logger).

  • status: Configuration的屬性,用來指定log4j本身的列印日誌的級別.
  • monitorinterval: Configuration的屬性,用於指定log4j自動重新配置的監測間隔時間,單位是s,最小是5s.

(2).Appenders節點

常見的有三種子節點:Console、RollingFile、File.

  • Console節點用來定義輸出到控制檯的Appender.

  • name:Console的屬性,指定Appender的名字.

  • target:Console的屬性,SYSTEM_OUT 或 SYSTEM_ERR,一般只設置預設:SYSTEM_OUT.

  • PatternLayout:Console的子節點,輸出格式,不設定預設為:%m%n. File節點用來定義輸出到指定位置的檔案的Appender.

  • name:File的屬性,指定Appender的名字.

  • fileName:File的屬性,指定輸出日誌的目的檔案帶全路徑的檔名.

  • PatternLayout:File的子節點,輸出格式,不設定預設為:%m%n.RollingFile節點用來定義超過指定大小自動刪除舊的建立新的的Appender.

  • name:RollingFilede的屬性,指定Appender的名字.

  • fileName:RollingFilede的屬性,指定輸出日誌的目的檔案帶全路徑的檔名.

  • filePattern:RollingFilede的屬性,指定新建日誌檔案的名稱格式.

  • PatternLayout:RollingFilede的子節點,輸出格式,不設定預設為:%m%n.

  • DefaultRolloverStrategy:RollingFilede的子節點,用來指定同一個資料夾下最多有幾個日誌檔案時開始刪除最舊的,建立新的(通過max屬性)。

  • Policies:RollingFilede的子節點,指定滾動日誌的策略,就是什麼時候進行新建日誌檔案輸出日誌.

  • TimeBasedTriggeringPolicy:Policies子節點,基於時間的滾動策略,interval屬性用來指定多久滾動一次,預設是1hour。modulate=true用來調整時間:比如現在是早上3am,interval是4,那麼第一次滾動是在4am,接著是8am,12am...而不是7am.

  • SizeBasedTriggeringPolicy:Policies子節點,基於指定檔案大小的滾動策略,size屬性用來定義每個日誌檔案的大小.

  • Filters:RollingFilede的子節點,決定日誌事件能否被輸出。過濾條件有三個值:ACCEPT(接受), DENY(拒絕) or NEUTRAL(中立)(後面具體講)ACCEP和DENY比較好理解就是接受和拒絕的意思,在使用單個過濾器的時候,一般就是使用這兩個值。但是在組合過濾器中,如果用接受ACCEPT的話,日誌資訊就會直接寫入日誌檔案,後續的過濾器不再進行過濾。所以,在組合過濾器中,接受使用NEUTRAL(中立),被第一個過濾器接受的日誌資訊,會繼續用後面的過濾器進行過濾,只有符合所有過濾器條件的日誌資訊,才會被最終寫入日誌檔案。

  • ThresholdFilter:Filters的子節點

  • level:ThresholdFilterde的屬性,將被過濾的級別。

  • onMatch:ThresholdFilterde的屬性,預設值是NEUTRAL

  • onMismatch:ThresholdFilterde的屬性,預設是DENY

(3).Loggers節點,

常見的有兩種:Root和Logger.

3.3.1 Root節點

Root節點用來指定專案的根日誌,如果沒有單獨指定Logger,那麼就會預設使用該Root日誌輸出

  • level:Root屬性,日誌輸出級別,共有8個級別,按照從低到高為:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

  • appender-ref:Root的子節點,用來指定該日誌輸出到哪個Appender,通過ref指定.

    <loggers>
        <root level="DEBUG">
            <appender-ref ref="Console"/>
        </root>
    </loggers>

3.3.2 Logger節點Logger節點

Logger節點用來單獨指定日誌的形式,比如要為指定包下的class指定不同的日誌級別等。

  • level:Logger屬性,日誌輸出級別,共有8個級別,按照從低到高為:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

  • name:Logger屬性,用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點.

  • additivity:Logger屬性

  • appender-ref:Logger的子節點,用來指定該日誌輸出到哪個Appender,如果沒有指定,就會預設繼承自Root.如果指定了,那麼會在指定的這個Appender和Root的Appender中都會輸出,此時我們可以設定Logger的additivity="false"只在自定義的Appender中進行輸出。

    <loggers>
        <logger name="druid.sql.Statement" level="debug" additivity="false">
            <appender-ref ref="druidSqlRollingFile"/>
        </logger>
        <logger name="org.springframework" level="OFF"/>
    </loggers>

四、日誌級別

共有8個級別,按照從低到高為:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

  1. All:最低等級的,用於開啟所有日誌記錄.

  2. Trace:是追蹤,就是程式推進以下,你就可以寫個trace輸出,所以trace應該會特別多,不過沒關係,我們可以設定最低日誌級別不讓他輸出.

  3. Debug:指出細粒度資訊事件對除錯應用程式是非常有幫助的.

  4. Info:訊息在粗粒度級別上突出強調應用程式的執行過程.

  5. Warn:輸出警告及warn以下級別的日誌.

  6. Error:輸出錯誤資訊日誌.

  7. Fatal:輸出每個嚴重的錯誤事件將會導致應用程式的退出的日誌.

  8. OFF:最高等級的,用於關閉所有日誌記錄.

程式會列印高於或等於所設定級別的日誌,設定的日誌等級越高,打印出來的日誌就越少。

五、實戰配置:log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>  
<configuration status="OFF">  
    <appenders>  
        <Console name="Console" target="SYSTEM_OUT">  
            <!--只接受程式中DEBUG級別的日誌進行處理-->  
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>  
            <PatternLayout pattern="\[%d{HH:mm:ss.SSS}\] %-5level %class{36} %L %M - %msg%xEx%n"/>  
        </Console>  
        <!--處理DEBUG級別的日誌,並把該日誌放到logs/debug.log檔案中-->  
        <!--打印出DEBUG級別日誌,每次大小超過size,則這size大小的日誌會自動存入按年份-月份建立的資料夾下面並進行壓縮,作為存檔-->  
        <RollingFile name="RollingFileDebug" fileName="./logs/debug.log"  
                     filePattern="logs/$${date:yyyy-MM}/debug-%d{yyyy-MM-dd}-%i.log.gz">  
            <Filters>  
                <!--只接受DEBUG級別的日誌,其餘的全部拒絕處理-->  
                <ThresholdFilter level="DEBUG"/>  
                <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL"/>  
            </Filters>  
            <!--輸出日誌的格式-->  
            <PatternLayout  
                    pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>  
            <Policies>  
                <SizeBasedTriggeringPolicy size="500 MB"/>  
                <TimeBasedTriggeringPolicy/>  
            </Policies>  
        </RollingFile>  
        <!--處理INFO級別的日誌,並把該日誌放到logs/info.log檔案中-->  
        <RollingFile name="RollingFileInfo" fileName="./logs/info.log"  
                     filePattern="logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz">  
            <Filters>  
                <!--只接受INFO級別的日誌,其餘的全部拒絕處理-->  
                <ThresholdFilter level="INFO"/>  
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>  
            </Filters>  
            <PatternLayout  
                    pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>  
            <Policies>  
                <SizeBasedTriggeringPolicy size="500 MB"/>  
                <TimeBasedTriggeringPolicy/>  
            </Policies>  
        </RollingFile>  
        <!--處理WARN級別的日誌,並把該日誌放到logs/warn.log檔案中-->  
        <RollingFile name="RollingFileWarn" fileName="./logs/warn.log"  
                     filePattern="logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz">  
            <Filters>  
                <ThresholdFilter level="WARN"/>  
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>  
            </Filters>  
            <PatternLayout  
                    pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>  
            <Policies>  
                <SizeBasedTriggeringPolicy size="500 MB"/>  
                <TimeBasedTriggeringPolicy/>  
            </Policies>  
        </RollingFile>  
        <!--處理error級別的日誌,並把該日誌放到logs/error.log檔案中-->  
        <RollingFile name="RollingFileError" fileName="./logs/error.log"  
                     filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">  
            <ThresholdFilter level="ERROR"/>  
            <PatternLayout  
                    pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>  
            <Policies>  
                <SizeBasedTriggeringPolicy size="500 MB"/>  
                <TimeBasedTriggeringPolicy/>  
            </Policies>  
        </RollingFile>  
        <!--druid的日誌記錄追加器-->  
        <RollingFile name="druidSqlRollingFile" fileName="./logs/druid-sql.log"  
                     filePattern="logs/$${date:yyyy-MM}/api-%d{yyyy-MM-dd}-%i.log.gz">  
            <PatternLayout pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %L %M - %msg%xEx%n"/>  
            <Policies>  
                <SizeBasedTriggeringPolicy size="500 MB"/>  
                <TimeBasedTriggeringPolicy/>  
            </Policies>  
        </RollingFile>  
    </appenders>  
    <!--     然後定義logger,只有定義了logger並引入的appender,appender才會生效 -->  
    <loggers>  
        <!--預設的root的logger-->  
        <root level="DEBUG">  
            <appender-ref ref="Console"/>  
            <appender-ref ref="RollingFileInfo"/>  
            <appender-ref ref="RollingFileWarn"/>  
            <appender-ref ref="RollingFileError"/>  
            <appender-ref ref="RollingFileDebug"/>  
        </root>  
        <!--額外配置的logger-->  
        <!--記錄druid-sql的記錄-->  
        <logger name="druid.sql.Statement" level="debug" additivity="false">  
            <appender-ref ref="druidSqlRollingFile"/>  
        </logger>  
        <!--log4j2 自帶過濾日誌-->  
        <Logger name="org.apache.catalina.startup.DigesterFactory" level="error" />  
        <Logger name="org.apache.catalina.util.LifecycleBase" level="error" />  
        <Logger name="org.apache.coyote.http11.Http11NioProtocol" level="warn" />  
        <logger name="org.apache.sshd.common.util.SecurityUtils" level="warn"/>  
        <Logger name="org.apache.tomcat.util.net.NioSelectorPool" level="warn" />  
        <Logger name="org.crsh.plugin" level="warn" />  
        <logger name="org.crsh.ssh" level="warn"/>  
        <Logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="error" />  
        <Logger name="org.hibernate.validator.internal.util.Version" level="warn" />  
        <logger name="org.springframework.boot.actuate.autoconfigure.CrshAutoConfiguration" level="warn"/>  
        <logger name="org.springframework.boot.actuate.endpoint.jmx" level="warn"/>  
        <logger name="org.thymeleaf" level="warn"/>  
    </loggers>  
</configuration>  

六、Springboot 依賴

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-log4j2</artifactId>  
</dependency>  

七、測試程式碼:

 

package com.log4j2;  
import org.apache.logging.log4j.Logger;  
import org.apache.logging.log4j.LogManager;  
   
public class test {  
   
    static Logger logger = LogManager.getLogger(test.class.getName());  
   
    public static boolean hello(){  
        logger.trace("entry");    //等同於logger.entry();但此方法在新版本好像已經廢棄  
        logger.error("Did it again!");  
        logger.info("這是info級資訊");  
        logger.debug("這是debug級資訊");  
        logger.warn("這是warn級資訊");          
        logger.fatal("嚴重錯誤");          
        logger.trace("exit");          
        return false;  
    }  
   
      
   
    public static void main(String\[\] args) {          
        logger.trace("開始主程式");          
        for(int i = 0; i < 10000; i++){  
            logger.info("當前i:"+i);  
            if(!test.hello()){  
                logger.error("hello");  
            }  
        }         
        logger.trace("退出程式");  
    }  
}  

八、log4j2.xml檔案結構

<?xml version="1.0" encoding="UTF-8"?>;  
<Configuration>  
  <Properties>  
    <Property name="name1">value</property>  
    <Property name="name2" value="value2"/>  
  </Properties>  
   
  <Filter type="type" ... />  
   
  <Appenders>  
    <Appender type="type" name="name">  
      <Filter type="type" ... />  
    </Appender>  
   
    ...  
   
  </Appenders>  
   
  <Loggers>  
    <Logger name="name1">  
      <Filter type="type" ... />  
    </Logger>  
   
    ...  
   
    <Root level="level">  
      <AppenderRef ref="name"/>  
    </Root>  
  </Loggers>  
   
</Configuration>

九、Filters

9.1 Filters決定日誌事件能否被輸出。

過濾條件有三個值:ACCEPT(接受), DENY(拒絕) or NEUTRAL(中立).

ACCEP和DENY比較好理解就是接受和拒絕的意思,在使用單個過濾器的時候,一般就是使用這兩個值。但是在組合過濾器中,如果用接受ACCEPT的話,日誌資訊就會直接寫入日誌檔案,後續的過濾器不再進行過濾。所以,在組合過濾器中,接受使用NEUTRAL(中立),被第一個過濾器接受的日誌資訊,會繼續用後面的過濾器進行過濾,只有符合所有過濾器條件的日誌資訊,才會被最終寫入日誌檔案。

9.2 ThresholdFilter

有3個引數:

  • level:將被過濾的級別。
  • onMatch:預設值是NEUTRAL
  • onMismatch:預設是DENY

如果LogEvent 中的 Log Level 大於 ThresholdFilter 中配置的 Log Level,那麼返回 onMatch 的值, 否則返回 onMismatch 的值,例如 : 如果ThresholdFilter 配置的 Log Level 是 ERROR , LogEvent 的Log Level 是 DEBUG。 那麼 onMismatch 的值將被返回, 因為 ERROR 小於DEBUG。如果是Accept,將自己被接受,而不經過下一個過濾器

9.3 例子

例子可以這樣理解:如果是INFO級別及其以上,將經過通過第一個過濾,進入第二個,否則是onMismatch:拒絕進入。對於第二個,如果是大於等於WARN(WARN/ERROR/ERROR),那麼將返回onMatch,也就是拒絕,如果是其他情況(也就是INFO),將是中立情況,因為後面沒有其他過濾器,則被接受。最後的結果就只剩下INFO級別的日誌。也就符合了RollingFileInfo只記錄Info級別的規則。

<RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"  filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">  
   
    <!--控制檯只輸出level及以上級別的資訊(onMatch),其他的直接拒絕(onMismatch)-->          
   
    <Filters>  
        <ThresholdFilter level="INFO"/>  
        <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>  
    </Filters>  
   
    <PatternLayout pattern="\[%d{HH:mm:ss:SSS}\] \[%p\] - %l - %m%n"/>  
   
    <Policies>  
        <TimeBasedTriggeringPolicy interval="24" modulate="true"/>  
        <SizeBasedTriggeringPolicy size="50 MB"/>  
    </Policies>  
   
    <DefaultRolloverStrategy max="20"/>  
   
</RollingFile>

十、Lookups

Lookups提供另外一種方式新增某些特殊的值到日誌中。

10.1 Date Lookup

與其他lookup不同,它不是通過key去查詢值,而是通過SimpleDateFormat驗證格式是否有效,然後記錄當前時間

<RollingFile name="Rolling-${map:type}" fileName="${filename}" filePattern="target/rolling1/test1-$${date:MM-dd-yyyy}.%i.log.gz">  
  <PatternLayout>  
    <pattern>%d %p %c{1.} \[%t\] %m%n</pattern>  
  </PatternLayout>  
  <SizeBasedTriggeringPolicy size="500" />  
</RollingFile>  

10.2 Context Map Lookup: 如記錄loginId

<File name="Application" fileName="application.log">  
  <PatternLayout>  
    <pattern>%d %p %c{1.} \[%t\] $${ctx:loginId} %m%n</pattern>  
  </PatternLayout>  
</File>  

這個的結果和前面的MDC是一樣的,即 %X{loginId}

10.3 Environment Lookup:記錄系統環境變數

比如可以獲取如/etc/profile中的變數值

<File name="Application" fileName="application.log">  
  <PatternLayout>  
    <pattern>%d %p %c{1.} \[%t\] $${env:USER} %m%n</pattern>  
  </PatternLayout>  
</File>  

10.4 System Properties Lookup

可以獲取Java中的系統屬性值。

<Appenders>  
  <File name="ApplicationLog" fileName="${sys:logPath}/app.log"/>  
</Appenders>  

和系統屬性值有什麼區別呢?其實就是System.getProperties();和System.getenv();的區別。下面是一個小例子。

package com.bensonlin.service.common;  
import java.util.Iterator;  
import java.util.Map;  
import java.util.Map.Entry;  
import java.util.Properties;  
   
public class Main {  
   
    public static void main(String\[\] args) {  
        Properties properties = System.getProperties();  
        Iterator i = properties.entrySet().iterator();  
        while (i.hasNext()) {  
            Map.Entry entry = (Map.Entry) i.next();  
            Object key = entry.getKey();  
            Object value = entry.getValue();  
            System.out.println(key + "=" + value);  
   
        }  
   
        System.out.println("===================");  
        Map map = System.getenv();  
        Iterator it = map.entrySet().iterator();  
        while (it.hasNext()) {  
            Entry entry = (Entry) it.next();  
            System.out.print(entry.getKey() + "=");  
            System.out.println(entry.getValue());  
        }  
    }  
}  

輸出(摘取部分):

java.runtime.name=Java(TM) SE Runtime Environment  
sun.boot.library.path=C:\\Program Files\\Java\\jdk1.8.0_25\\jre\\bin  
java.vm.version=25.25-b02  
java.vm.vendor=Oracle Corporation  
java.vendor.url=http://java.oracle.com/  
path.separator=;  
...  
===================  
JAVA\_HOME=C:\\Program Files\\Java\\jdk1.8.0\_25  
TEMP=D:\\Temp  
ProgramFiles=C:\\Program Files  
...  

可以看到其實Environment是獲取環境變數,而System Properties獲取的更多是與Java相關的值

--------------------- 
作者:HermanChow 
來源:CSDN 
原文:https://blog.csdn.net/u013160017/article/details/81392154 
版權宣告:本文為博主原創文章,轉載請