天天看點

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有兩個屬性: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.

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

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

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

    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中進行輸出。

四、日志級别

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

All:最低等級的,用于打開所有日志記錄.

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

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

Info:消息在粗粒度級别上突出強調應用程式的運作過程.

Warn:輸出警告及warn以下級别的日志.

Error:輸出錯誤資訊日志.

Fatal:輸出每個嚴重的錯誤事件将會導緻應用程式的退出的日志.

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

(1)Filters決定日志事件能否被輸出。過濾條件有三個值:ACCEPT(接受), DENY(拒絕) or NEUTRAL(中立).

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

(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,将自己被接受,而不經過下一個過濾器

(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提供另外一種方式添加某些特殊的值到日志中。

(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>
           

(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}

(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>
           

(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相關的值

如果您喜歡這篇文章請在下面點個贊和收藏。謝謝您的支援!