log4j2通俗易懂讲解

747 阅读2分钟

log4j2值得注意的特性

  • log4j2版本配置文件不再支持log4j中的properties,只支持xml配置,也就是log4j2.xml
  • 在logback 中,Appender中的异常不会被应用感知到,log4j2中提供了异常处理机制
  • 性能提升,log4j2相比于log4j,logback都有明显的性能提升,支持异步日志打印
  • 自动重载配置,动态修改日志配置而不用重启应用就可以生效

主要的三个配置项

  • Loggers
  • Appenders
  • Layouts

loggers

指定什么包或者什么类需要输出日志,并且可以设置什么日志级别才输出,以及输出的位置以及日志文件大小设定等

日志级别由小到大排列为:debug《info《warn《error《fatal(致命的,灾难的; Loggers下有一个root级别的logger,当有些类或者包没有具体指定logger就用root的配置

Appenders

指定日志输出的格式,和上面的loggers搭配使用,Loggers里的Logger必须指定一个Appender,让自己的日志打印按照Appender的配置生效 appenders下有以下几种appender类型

  • console:定义输出到控制台的appender,也可以设置多个吧
  • RollingFile:大致是滚筒日志,日志打印到一个日志文件,到了设定的值就,存到下一个日志文件,可以设置多个RollingFile,比如把debug和info等都新设置一个RollingFile
  • File:指定普通日志文件

Layouts

日志文件格式的配置,可以配置到appender下的子节点

常见配置如下

<?xml version="1.0" encoding="UTF-8"?>  
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->  
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数(最小是5秒钟)-->  
<configuration monitorInterval="5" status="warn">  
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->  
  
  
<!--变量配置-->  
<Properties>  
<!-- 格式化输出:%date表示日期(可缩写成%d,后同),%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->  
<!-- %logger{36} 表示 Logger 名字最长36个字符 -->  
<property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss,SSS} %highlight{%-5level} [%t] %highlight{%c{1.}.%M(%L)}: %msg%n" />  
<!-- 定义日志存储的路径 -->  
<property name="FILE_PATH" value="log" />  
<!--<property name="FILE_NAME" value="myProject" />-->  
</Properties>  
  
<!--此节点有三种常见的子节点:Console,RollingFile,File-->  
<appenders>  
  
<!--console节点用来定义输出到控制台的Appender-->  
<!--target:SYSTEM_OUT或SYSTEM_ERR,一般只设置默认:SYSTEM_OUT-->  
<console name="Console" target="SYSTEM_OUT">  
<!--输出日志的格式,默认为:%m%n,即只输出日志和换行-->  
<PatternLayout pattern="${LOG_PATTERN}"/>  
<!--阈值过滤器,控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->  
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>  
</console>  
  
<!-- &lt;!&ndash;文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,适合临时测试用&ndash;&gt;-->  
<!-- <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">-->  
<!-- <PatternLayout pattern="${LOG_PATTERN}"/>-->  
<!-- </File>-->  
  
  
<!-- 这个会打印出所有的debug及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->  
<RollingFile name="RollingFileDebug" fileName="${FILE_PATH}/debug.log" filePattern="${FILE_PATH}/debug/DEBUG-%d{yyyy-MM-dd}_%i.log.gz">  
<!--阈值过滤器,控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->  
<ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>  
<!--如果配置的是“%d{yyyy-MM}”,滚动时间单位就是月。“%d{yyyy-MM-dd}”,滚动时间单位就是天-->  
<PatternLayout pattern="${LOG_PATTERN}"/>  
<!--指定滚动日志的策略,就是指定新建日志文件的时机-->  
<Policies>  
<!--interval属性用来指定多久滚动一次,时间单位取决于<PatternLayout pattern>,modulate属性调整时间,true:0点为基准滚动,false:服务器启动时间开始滚动-->  
<TimeBasedTriggeringPolicy interval="1" modulate="true" />  
<SizeBasedTriggeringPolicy size="100MB"/>  
</Policies>  
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->  
<DefaultRolloverStrategy max="15">  
<!--删除15天之前的日志-->  
<Delete basePath="${FILE_PATH}" maxDepth="2">  
<IfFileName glob="*/*.log.gz" />  
<IfLastModified age="360H" />  
</Delete>  
</DefaultRolloverStrategy>  
</RollingFile>  
  
  
<!-- 这个会打印出所有的warn及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->  
<RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/info/INFO-%d{yyyy-MM-dd}_%i.log.gz">  
<!--阈值过滤器,控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->  
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>  
<PatternLayout pattern="${LOG_PATTERN}"/>  
<Policies>  
<!--interval属性用来指定多久滚动一次,时间单位取决于<PatternLayout pattern>,modulate属性调整时间,true:0点为基准滚动,false:服务器启动时间开始滚动-->  
<TimeBasedTriggeringPolicy interval="1" modulate="true" />  
<SizeBasedTriggeringPolicy size="100MB"/>  
</Policies>  
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->  
<DefaultRolloverStrategy max="15"/>  
</RollingFile>  
  
  
<!-- 这个会打印出所有的error及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->  
<RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/error/ERROR-%d{yyyy-MM-dd}_%i.log.gz">  
<!--阈值过滤器,控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->  
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>  
<PatternLayout pattern="${LOG_PATTERN}"/>  
<Policies>  
<!--interval属性用来指定多久滚动一次,时间单位取决于<PatternLayout pattern>,modulate属性调整时间,true:0点为基准滚动,false:服务器启动时间开始滚动-->  
<TimeBasedTriggeringPolicy interval="1" modulate="true" />  
<SizeBasedTriggeringPolicy size="100MB"/>  
</Policies>  
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->  
<DefaultRolloverStrategy max="15"/>  
</RollingFile>  
<!--启用异步日志(这是log4j自带的异步日志),阻塞队列最大容量为20000,超出队列容量时是否等待日志输出,不等待将直接将日志丢弃-->  
<Async name="Async" bufferSize="20000" blocking="true">  
<AppenderRef ref="Console"/>  
<AppenderRef ref="RollingFileDebug"/>  
<AppenderRef ref="RollingFileInfo"/>  
<AppenderRef ref="RollingFileError"/>  
</Async>  
</appenders>  
  
  
<!--Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。-->  
<!--然后定义loggers,只有定义了logger并引入的appender,appender才会生效-->  
<loggers>  
<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->  
<logger name="org.mybatis" level="info" additivity="false">  
<AppenderRef ref="Async"/>  
</logger>  
<!--监控系统信息-->  
<!--若是additivity设为false,则 子Logger 只会在自己的appender里输出,而不会在 父Logger 的appender里输出。-->  
<Logger name="org.springframework" level="info" additivity="false">  
<AppenderRef ref="Async"/>  
</Logger>  
<!--root 节点用来指定项目的根日志,其他没指定的日志打印就是按照根日志配置打印,level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.-->  
<root level="debug">  
<AppenderRef ref="Async" />  
</root>  
<!--引用外部的组件实现异步日志(disruptor)-->  
<AsynLogger>  
<AppenderRef ref="RollingFileError" />  
</AsynLogger>  
</loggers>  
  
  
</configuration>

异步日志

  • 有log4j2自带的异步日志
  • 配合disruptor实现异步日志(效果最佳),原理值得一看