小白使用log4j2配置文件log4j2.xml详细说明

log4j2配置文件log4j2.xml

背景

搭项目环境刚好用到,查了很多资料,就总结了一个笔记.

关于配置文件的名称以及在在项目中的存放位置

log4j2.版本不再支持像1.x中的.properties后缀的文件配置方式,2.x版本配置文件后缀名只能为".xml",".json"或者".jsn".
系统选择配置文件的优先级(先后顺序)如下:
(1).classpath下的名为log4j2-test.json或者log4j2-test.jsn的文件
(2).classpath下的名为log4j2-test.xml文件
(3).classpath下名为log4j2.xml或者log4j2.jsn的文件
(4).classpath下名为log4j2.xml的文件
我们一般默认使用log4j2.xml进行命名如果本地要测试,可以把log4j2-test.xml放到classpath,而正式环境使用log4j2.xml,则再打包部署的时候不要打包log4j2-test.xml即可.

日志的level

trace<debug<info<warn<error<fatal

注:日志输出等级越小,输出日志内容越详细.具体可以百度日志等级输出.

缺省默认配置文件

<?xml version="1.0" encoding="UTF-8"?>

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

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

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

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

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

name:指定Appender的名字.

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

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

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

name:指定Appender的名字.

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

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

RollingFile节点用来定义超过指定大小自动归档（rolling）旧的创建新的的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属性)。

Filter: 日志过滤，如：，表示debug级别以上的log会被打印。

Socket节点用来定义将日志输出至别的服务器上，如：

3. loggers节点

logger表明，对某一文件，只有高于某级别，才被打印

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

比较完整的log4j2.xml配置模板

<?xml version="1.0" encoding="UTF-8"?>

 <!--先定义所有的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">   其他logger输出所有的日志信息

         <appender-ref ref="Console"/>

         <appender-ref ref="RollingFileInfo"/>

         <appender-ref ref="RollingFileWarn"/>

         <appender-ref ref="RollingFileError"/>

     </root>

 </loggers>

## 用户自定义级别日志CustomLevels

Standard log levels built-in to Log4J

Standard log levels built-in to Log4J

Standard Levle	Value
OFF	0
FATAL	100
ERROR	200
WARN	300
INFO	400
DEBUG	500
TRACE	600
ALL	Integer.MAX_VALUE