springboot配置log4j2日志

1.首先引入相關(guān)依賴

<dependency>  
  <groupId>org.springframework.boot</groupId>  
  <artifactId>spring-boot-starter-web</artifactId>  
  <exclusions><!-- 去掉springboot默認配置 -->  
      <exclusion>  
          <groupId>org.springframework.boot</groupId>  
          <artifactId>spring-boot-starter-logging</artifactId>  
      </exclusion>  
  </exclusions>  
</dependency> 

<dependency> <!-- 引入log4j2依賴 -->  
  <groupId>org.springframework.boot</groupId>  
  <artifactId>spring-boot-starter-log4j2</artifactId>  
</dependency> 

<dependency><!-- 解析log4j2.yml -->  
     <groupId>com.fasterxml.jackson.dataformat</groupId>
     <artifactId>jackson-dataformat-yaml</artifactId>
</dependency>

2.springboot會自動查找靜態(tài)資源目錄最外層的log4j2.yml

  1. log4j2.yml和log4j.xml相對應(yīng)
    先看log4j2.xml
<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status,這個用于設(shè)置log4j2自身內(nèi)部的信息輸出,可以不設(shè)置,當(dāng)設(shè)置成trace時,你會看到log4j2內(nèi)部各種詳細輸出-->
<!--monitorInterval:Log4j能夠自動檢測修改配置 文件和重新配置本身,設(shè)置間隔秒數(shù)-->
<configuration monitorInterval="5">
  <!--日志級別以及優(yōu)先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

  <!--變量配置-->
  <Properties>
    <!-- 格式化輸出:%date表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度 %msg:日志消息,%n是換行符-->
    <!-- %logger{36} 表示 Logger 名字最長36個字符 -->
    <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
    <!-- 定義日志存儲的路徑 -->
    <property name="FILE_PATH" value="更換為你的日志路徑" />
    <property name="FILE_NAME" value="更換為你的項目名" />
  </Properties>

  <appenders>

    <console name="Console" target="SYSTEM_OUT">
      <!--輸出日志的格式-->
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <!--控制臺只輸出level及其以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
      <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
    </console>

    <!--文件會打印出所有信息,這個log每次運行程序會自動清空,由append屬性決定,適合臨時測試用-->
    <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
      <PatternLayout pattern="${LOG_PATTERN}"/>
    </File>

    <!-- 這個會打印出所有的info及以下級別的信息,每次大小超過size,則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮,作為存檔-->
    <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
      <!--控制臺只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
      <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <Policies>
        <!--interval屬性用來指定多久滾動一次,默認是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </Policies>
      <!-- DefaultRolloverStrategy屬性如不設(shè)置,則默認為最多同一文件夾下7個文件開始覆蓋-->
      <DefaultRolloverStrategy max="15"/>
    </RollingFile>

    <!-- 這個會打印出所有的warn及以下級別的信息,每次大小超過size,則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮,作為存檔-->
    <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
      <!--控制臺只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
      <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <Policies>
        <!--interval屬性用來指定多久滾動一次,默認是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </Policies>
      <!-- DefaultRolloverStrategy屬性如不設(shè)置,則默認為最多同一文件夾下7個文件開始覆蓋-->
      <DefaultRolloverStrategy max="15"/>
    </RollingFile>

    <!-- 這個會打印出所有的error及以下級別的信息,每次大小超過size,則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮,作為存檔-->
    <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
      <!--控制臺只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
      <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <Policies>
        <!--interval屬性用來指定多久滾動一次,默認是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </Policies>
      <!-- DefaultRolloverStrategy屬性如不設(shè)置,則默認為最多同一文件夾下7個文件開始覆蓋-->
      <DefaultRolloverStrategy max="15"/>
    </RollingFile>

  </appenders>

  <!--Logger節(jié)點用來單獨指定日志的形式,比如要為指定包下的class指定不同的日志級別等。-->
  <!--然后定義loggers,只有定義了logger并引入的appender,appender才會生效-->
  <loggers>

    <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
      <AppenderRef ref="Console"/>
    </logger>
    <!--監(jiān)控系統(tǒng)信息-->
    <!--若是additivity設(shè)為false,則 子Logger 只會在自己的appender里輸出,而不會在 父Logger 的appender里輸出。-->
    <Logger name="org.springframework" level="info" additivity="false">
      <AppenderRef ref="Console"/>
    </Logger>

    <root level="info">
      <appender-ref ref="Console"/>
      <appender-ref ref="Filelog"/>
      <appender-ref ref="RollingFileInfo"/>
      <appender-ref ref="RollingFileWarn"/>
      <appender-ref ref="RollingFileError"/>
    </root>
  </loggers>

</configuration>
  1. log4j2.yml

Configuration:
  status: warn  #日志框架本身的日志輸出級別
  monitorInterval: 30   #自動加載配置文件的時間間隔

  Properties: # 定義全局變量
    Property: # 缺省配置(用于開發(fā)環(huán)境)。其他環(huán)境需要在VM參數(shù)中指定,如下:
      #測試:-Dlog.level.console=warn -Dlog.level.xjj=trace
      #生產(chǎn):-Dlog.level.console=warn -Dlog.level.xjj=info
      - name: log.level.console
        value: info
      - name: log.path
        value: log
      - name: project.name
        value: 工程名
      - name: log.pattern
        value: "%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-30.30C{1.} : %m%n"

  Appenders:
    Console:  #配置控制臺輸出的格式
      name: CONSOLE
      target: SYSTEM_OUT
      PatternLayout:
        pattern: ${log.pattern}

#    Async:  #異步日志
#      name: myAsync
#      AppenderRef: CONSOLE  #控制臺輸出做異步操作

    RollingFile:  #按照指定規(guī)則來拆分日志
      - name: ROLLING_FILE
        fileName: ${log.path}/${project.name}.log   #日志輸出的路徑,變量取前置定義的全局變量
        filePattern: "${log.path}/historyRunLog/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:  #配置文件輸出格式
          pattern: ${log.pattern}
        Filters:
          #        一定要先去除不接受的日志級別,然后獲取需要接受的日志級別
          ThresholdFilter:
            - level: error
              onMatch: DENY
              onMismatch: NEUTRAL
            - level: info
              onMatch: ACCEPT
              onMismatch: DENY
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分類
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100個
          max: 100
      #   平臺日志
      - name: PLATFORM_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/platform/${project.name}_platform.log 
        filePattern: "${log.path}/platform/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分類
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100個
          max: 100
      #   業(yè)務(wù)日志
      - name: BUSSINESS_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/bussiness/${project.name}_bussiness.log
        filePattern: "${log.path}/bussiness/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分類
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100個
          max: 100
      #   錯誤日志
      - name: EXCEPTION_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/exception/${project.name}_exception.log
        filePattern: "${log.path}/exception/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        ThresholdFilter:
          level: error
          onMatch: ACCEPT
          onMismatch: DENY
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分類
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100個
          max: 100
      #   DB 日志
      - name: DB_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/db/${project.name}_db.log
        filePattern: "${log.path}/db/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分類
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100個
          max: 100


  Loggers:
    Root:   #根結(jié)點配置引用等規(guī)則
      level: info
      AppenderRef:
        - ref: CONSOLE  #引用控制臺輸出
        - ref: ROLLING_FILE   #引用文件輸出
        - ref: EXCEPTION_ROLLING_FILE
#        - ref: myAsync
    Logger:   #各個命名的輸出級別,是否應(yīng)用,引用的配置
      - name: platform    
        level: info
        additivity: false
        AppenderRef:
          - ref: CONSOLE
          - ref: PLATFORM_ROLLING_FILE

      - name: bussiness
        level: info
        additivity: false
        AppenderRef:
          - ref: BUSSINESS_ROLLING_FILE

      - name: exception
        level: debug
        additivity: true
        AppenderRef:
          - ref: EXCEPTION_ROLLING_FILE

      - name: db
        level: info
        additivity: false
        AppenderRef:
          - ref: DB_ROLLING_FILE


#    監(jiān)聽具體包下面的日志
#    Logger: # 為com.xjj包配置特殊的Log級別,方便調(diào)試
#      - name: com.xjj
#        additivity: false
#        level: ${sys:log.level.xjj}
#        AppenderRef:
#          - ref: CONSOLE
#          - ref: ROLLING_FILE

配置參數(shù)簡介
在這里簡單介紹下常用的配置參數(shù)

日志級別
機制:如果一條日志信息的級別大于等于配置文件的級別,就記錄。

trace:追蹤,就是程序推進一下,可以寫個trace輸出
debug:調(diào)試,一般作為最低級別,trace基本不用。
info:輸出重要的信息,使用較多
warn:警告,有些信息不是錯誤信息,但也要給程序員一些提示。
error:錯誤信息。用的也很多。
fatal:致命錯誤。
輸出源
CONSOLE(輸出到控制臺)
FILE(輸出到文件)
格式
SimpleLayout:以簡單的形式顯示
HTMLLayout:以HTML表格顯示
PatternLayout:自定義形式顯示

PatternLayout自定義日志布局:
%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生產(chǎn)時間,輸出到毫秒的時間
%-5level : 輸出日志級別,-5表示左對齊并且固定輸出5個字符,如果不足在右邊補0
%c : logger的名稱(%logger)
%t : 輸出當(dāng)前線程名稱
%p : 日志輸出格式
%m : 日志內(nèi)容,即 logger.info("message")
%n : 換行符
%C : Java類名(%F)
%L : 行號
%M : 方法名
%l : 輸出語句所在的行數(shù), 包括類名、方法名、文件名、行數(shù)
hostName : 本地機器名
hostAddress : 本地ip地址
Log4j2配置詳解
根節(jié)點Configuration
有兩個屬性:
status
monitorinterval
有兩個子節(jié)點:

  • Appenders
  • Loggers(表明可以定義多個Appender和Logger).

status用來指定log4j本身的打印日志的級別.
monitorinterval用于指定log4j自動重新配置的監(jiān)測間隔時間,單位是s,最小是5s.

Appenders節(jié)點
常見的有三種子節(jié)點:Console、RollingFile、File

Console節(jié)點用來定義輸出到控制臺的Appender.
name:指定Appender的名字.
target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設(shè)置默認:SYSTEM_OUT.
PatternLayout:輸出格式,不設(shè)置默認為:%m%n.

File節(jié)點用來定義輸出到指定位置的文件的Appender.
name:指定Appender的名字.
fileName:指定輸出日志的目的文件帶全路徑的文件名.
PatternLayout:輸出格式,不設(shè)置默認為:%m%n.

RollingFile節(jié)點用來定義超過指定條件自動刪除舊的創(chuàng)建新的Appender.
name:指定Appender的名字.
fileName:指定輸出日志的目的文件帶全路徑的文件名.
PatternLayout:輸出格式,不設(shè)置默認為:%m%n.
filePattern : 指定當(dāng)發(fā)生Rolling時,文件的轉(zhuǎn)移和重命名規(guī)則.
Policies:指定滾動日志的策略,就是什么時候進行新建日志文件輸出日志.
TimeBasedTriggeringPolicy:Policies子節(jié)點,基于時間的滾動策略,interval屬性用來指定多久滾動一次,默認是1 hour。modulate=true用來調(diào)整時間:比如現(xiàn)在是早上3am,interval是4,那么第一次滾動是在4am,接著是8am,12am...而不是7am.
SizeBasedTriggeringPolicy:Policies子節(jié)點,基于指定文件大小的滾動策略,size屬性用來定義每個日志文件的大小.
DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的,創(chuàng)建新的(通過max屬性)。

Loggers節(jié)點,常見的有兩種:Root和Logger.
Root節(jié)點用來指定項目的根日志,如果沒有單獨指定Logger,那么就會默認使用該Root日志輸出
level:日志輸出級別,共有8個級別,按照從低到高為:All < Trace < Debug < Info < Warn < Error < AppenderRef:Root的子節(jié)點,用來指定該日志輸出到哪個Appender.
Logger節(jié)點用來單獨指定日志的形式,比如要為指定包下的class指定不同的日志級別等。
level:日志輸出級別,共有8個級別,按照從低到高為:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節(jié)點.
AppenderRef:Logger的子節(jié)點,用來指定該日志輸出到哪個Appender,如果沒有指定,就會默認繼承自Root.如果指定了,那么會在指定的這個Appender和Root的Appender中都會輸出,此時我們可以設(shè)置Logger的additivity="false"只在自定義的Appender中進行輸出。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容