Springboot - log4j2

log4j2

springboot中默认的日志框架是logback，如果要使用log4j2，需要先去除默认的日志框架

<!-- 去除系统默认的logback日志框架，使用自己配置的框架 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter</artifactId>
   <exclusions>
      <exclusion>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-logging</artifactId>
      </exclusion>
   </exclusions>
</dependency>

<!-- 配置 log4j2 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-log4j2</artifactId>
   <version>2.0.2.RELEASE</version>
</dependency>

配置文件节点解析

根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).

• status用来指定log4j本身的打印日志的级别.

• monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.

Appenders节点，常见的有三种子节点:Console、RollingFile、File.

• Console节点用来定义输出到控制台的Appender.

• name:指定Appender的名字.

• target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

• PatternLayout:输出格式，不设置默认为:%m%n.

• File节点用来定义输出到指定位置的文件的Appender.

• name:指定Appender的名字.

• fileName:指定输出日志的目的文件带全路径的文件名.

• PatternLayout:输出格式，不设置默认为:%m%n.

• RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.

• name:指定Appender的名字.

• fileName:指定输出日志的目的文件带全路径的文件名.

• PatternLayout:输出格式，不设置默认为:%m%n.

• filePattern:指定新建日志文件的名称格式.

• Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.

• TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.

• SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.

• DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

Loggers节点，常见的有两种:Root和Logger.

• Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出

• level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

• AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

• Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

• level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

• name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.

• AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

关于日志level.

共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

• All:最低等级的，用于打开所有日志记录.

• Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.

• Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

• Info:消息在粗粒度级别上突出强调应用程序的运行过程.

• Warn:输出警告及warn以下级别的日志.

• Error:输出错误信息日志.

• Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

• OFF:最高等级的，用于关闭所有日志记录.

程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

<?xml version="1.0" encoding="UTF-8"?><!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5" status="warn">
   <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
   <!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
   <!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->

   <!--变量配置-->
   <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="LOG_PATTERN" value="%clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{[%5p]} %clr{[%thread]}{magenta} %clr{---}{faint} %clr{%logger{36}}{cyan} %clr{:::}{faint} %m%n%xwEx" />-->
      <!-- 定义日志存储的路径，不要配置相对路径 -->
      <property name="FILE_PATH" value="c:/logs" />
      <property name="FILE_NAME" value="log-dimples" />
   </properties>

   <appenders>

      <console name="Console" target="SYSTEM_OUT">
         <!--输出日志的格式-->
         <PatternLayout pattern="${LOG_PATTERN}" />
         <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
         <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
      </console>

      <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
      <File name="FileLog" fileName="${FILE_PATH}/test/test.log" append="false">
         <PatternLayout pattern="${LOG_PATTERN}" />
      </File>

      <!-- 这个会打印出所有的debug及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
      <RollingFile name="RollingFileDebug" fileName="${FILE_PATH}/debug/debug.log"
         filePattern="${FILE_PATH}/debug/${FILE_NAME}-DEBUG-%d{yyyy-MM-dd}_%i.log.gz">
         <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
         <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
         <PatternLayout pattern="${LOG_PATTERN}" />
         <Policies>
            <!--interval属性用来指定多久滚动一次，默认是1 hour-->
            <TimeBasedTriggeringPolicy interval="1" />
            <SizeBasedTriggeringPolicy size="10MB" />
         </Policies>
         <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
         <DefaultRolloverStrategy max="100" />
      </RollingFile>

      <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
      <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info/info.log"
         filePattern="${FILE_PATH}/info/${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属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
         <DefaultRolloverStrategy max="100" />
      </RollingFile>

      <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
      <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn/warn.log"
         filePattern="${FILE_PATH}/warn/${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属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
         <DefaultRolloverStrategy max="100" />
      </RollingFile>

      <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
      <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error/error.log"
         filePattern="${FILE_PATH}/error/${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属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
         <DefaultRolloverStrategy max="100" />
      </RollingFile>

   </appenders>

   <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
   <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
   <loggers>

      <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
      <logger name="org.mybatis" level="info" additivity="false">
         <AppenderRef ref="Console" />
      </logger>
      <!--监控系统信息-->
      <!--若是additivity设为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="RollingFileDebug"/>
         <appender-ref ref="RollingFileInfo" />
         <appender-ref ref="RollingFileWarn" />
         <appender-ref ref="RollingFileError" />
      </root>
   </loggers>

</configuration>

<?xml version="1.0" encoding="UTF-8" ?>
<Configuration>
   <!-- Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，
    你会看到log4j2内部各种详细输出。可以设置成OFF(关闭)或Error(只输出错误信息) -->
   <status>warn</status>
   <monitorInterval>30</monitorInterval>
   <!-- 定义全局的变量 -->
   <Properties>
      <!-- 控制台日志输出级别 -->
      <Property>
         <name>log.level.console</name>
         <value>debug</value>
      </Property>
      <!-- 日志输出路径 -->
      <Property>
         <name>log.path</name>
         <value>c:/log_dimples</value>
      </Property>
      <!-- 日志输出名字 -->
      <Property>
         <name>project.name</name>
         <value>dimples-log</value>
      </Property>
      <!-- 日志输出格式 -->
      <Property>
         <name>log.pattern</name>
         <value>%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-30.30C{1.} : %m%n</value>
      </Property>
   </Properties>
   <Appenders>
      <!-- 定义控制台输出配置 -->
      <Console>
         <name>CONSOLE</name>
         <target>SYSTEM_OUT</target>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
      </Console>
      <RollingRandomAccessFile>
         <name>ROLLING_FILE</name>
         <fileName>${log.path}/${project.name}.log</fileName>
         <filePattern>
            ${log.path}/historyRunLog/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Filters>
            <ThresholdFilter>
               <level>debug</level>
               <onMatch>ACCEPT</onMatch>
               <onMismatch>ACCEPT</onMismatch>
            </ThresholdFilter>
         </Filters>
         <!-- 日志切分规则 -->
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <!-- 指定每天的最大压缩包个数，默认7个，超过了会覆盖之前的 -->
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>PLATFORM_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/platform/${project.name}_platform.log</fileName>
         <filePattern>
            ${log.path}/platform/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>BUSINESS_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/business/${project.name}_business.log</fileName>
         <filePattern>
            ${log.path}/business/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>EXCEPTION_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/exception/${project.name}_exception.log</fileName>
         <filePattern>
            ${log.path}/exception/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <ThresholdFilter>
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
         </ThresholdFilter>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
      <RollingRandomAccessFile>
         <name>DB_ROLLING_FILE</name>
         <ignoreExceptions>false</ignoreExceptions>
         <fileName>${log.path}/db/${project.name}_db.log</fileName>
         <filePattern>${log.path}/db/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz
         </filePattern>
         <PatternLayout>
            <pattern>${log.pattern}</pattern>
         </PatternLayout>
         <Policies>
            <TimeBasedTriggeringPolicy>
               <modulate>true</modulate>
               <interval>1</interval>
            </TimeBasedTriggeringPolicy>
         </Policies>
         <DefaultRolloverStrategy>
            <max>100</max>
         </DefaultRolloverStrategy>
      </RollingRandomAccessFile>
   </Appenders>
   <Loggers>
      <Root>
         <level>info</level>
         <AppenderRef>
            <ref>CONSOLE</ref>
         </AppenderRef>
         <AppenderRef>
            <ref>ROLLING_FILE</ref>
         </AppenderRef>
         <AppenderRef>
            <ref>EXCEPTION_ROLLING_FILE</ref>
         </AppenderRef>
      </Root>
      <Logger>
         <name>platform</name>
         <level>info</level>
         <additivity>false</additivity>
         <AppenderRef>
            <ref>CONSOLE</ref>
         </AppenderRef>
         <AppenderRef>
            <ref>PLATFORM_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
      <Logger>
         <name>business</name>
         <level>info</level>
         <additivity>false</additivity>
         <AppenderRef>
            <ref>BUSINESS_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
      <Logger>
         <name>exception</name>
         <level>debug</level>
         <additivity>true</additivity>
         <AppenderRef>
            <ref>EXCEPTION_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
      <Logger>
         <name>db</name>
         <level>info</level>
         <additivity>false</additivity>
         <AppenderRef>
            <ref>DB_ROLLING_FILE</ref>
         </AppenderRef>
      </Logger>
   </Loggers>
</Configuration>