天天看點

log4j2配置檔案log4j2.xml

最近由于項目的需要,我們把log4j 1.x的版本全部遷移成log4j 2.x 的版本,那随之而來的slf4j整合log4j的配置(**使用Slf4j內建Log4j2建構項目日志系統的完美解決方案**)以及log4j2配置檔案的詳解,就需要我們來好好聊一聊了。本文就專門來講解下log4j2.xml配置檔案的各項标簽的意義。

一、背景

  最近由于項目的需要,我們把log4j 1.x的版本全部遷移成log4j 2.x 的版本,那随之而來的slf4j整合log4j的配置(使用Slf4j內建Log4j2建構項目日志系統的完美解決方案)以及log4j2配置檔案的詳解,就需要我們來好好聊一聊了。本文就專門來講解下log4j2.xml配置檔案的各項标簽的意義。

二、配置全解

  1.關于配置檔案的名稱以及在項目中的存放位置

    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即可。

  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(表明可以定義多個Appender和Logger).

       status用來指定log4j本身的列印日志的級别.

       monitorinterval用于指定log4j自動重新配置的監測間隔時間,機關是s,最小是5s.

    (2).Appenders節點,常見的有三種子節點:Console、RollingFile、File.

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

        name:指定Appender的名字.

        target:SYSTEM_OUT 或 SYSTEM_ERR,一般隻設定預設:SYSTEM_OUT.

        PatternLayout:輸出格式,不設定預設為:%m%n.

       File節點用來定義輸出到指定位置的檔案的Appender.

        fileName:指定輸出日志的目的檔案帶全路徑的檔案名.

       RollingFile節點用來定義超過指定大小自動删除舊的建立新的的Appender.

        filePattern:指定建立日志檔案的名稱格式.

        Policies:指定滾動日志的政策,就是什麼時候進行建立日志檔案輸出日志.

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

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

        DefaultRolloverStrategy:用來指定同一個檔案夾下最多有幾個日志檔案時開始删除最舊的,建立新的(通過max屬性)。

    (3).Loggers節點,常見的有兩種:Root和Logger.

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

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

         AppenderRef:Root的子節點,用來指定該日志輸出到哪個Appender.

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

         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:最高等級的,用于關閉所有日志記錄.

      程式會列印高于或等于所設定級别的日志,設定的日志等級越高,列印出來的日志就越少。

  4.比較完整的log4j2.xml配置模闆

<?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">
    <!--先定義所有的appender-->
    <appenders>
    <!--這個輸出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
        <!--輸出日志的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>
    <!--檔案會列印出所有資訊,這個log每次運作程式會自動清空,由append屬性決定,這個也挺有用的,适合臨時測試用-->
    <File name="log" fileName="log/test.log" append="false">
       <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
    </File>
    <!-- 這個會列印出所有的info及以下級别的資訊,每次大小超過size,則這size大小的日志會自動存入按年份-月份建立的檔案夾下面并進行壓縮,作為存檔-->
        <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)-->        
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
        <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                     filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        <!-- DefaultRolloverStrategy屬性如不設定,則預設為最多同一檔案夾下7個檔案,這裡設定了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                     filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </appenders>
    <!--然後定義logger,隻有定義了logger并引入的appender,appender才會生效-->
    <loggers>
        <!--過濾掉spring和mybatis的一些無用的DEBUG資訊-->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>
</configuration>