log4j2配置文件log4j2.xml

mac2022-06-30  15

一、背景

    log4j2.xml本身已经接触了很久了,但都属于一知半解,最近在做aws uploading files的temporary credentials, 有一个debug leval 的日志,虽然不影响最后的使用,但是在日志文件里非常的难看,所以想通过log4j2的配置,隐藏掉这条日志文件,加上项目本身不是很忙,干脆就好好总结一下。

二、关于配置文件的名称以及在项目中的存放位置以及日志的leval

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

       trace<debug<info<warn<error<fatal

三、缺省默认配置文件

1 <?xml version="1.0" encoding="UTF-8"?> 2 <Configuration status="WARN"> 3 <Appenders> 4 <Console name="Console" target="SYSTEM_OUT"> 5 <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> 6 </Console> 7 </Appenders> 8 <Loggers> 9 <Root level="error"> 10 <AppenderRef ref="Console"/> 11 </Root> 12 </Loggers> 13 </Configuration>   根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).

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

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

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: 日志过滤,如:<ThresholdFilter level="DEBUG"/>,表示debug级别以上的log会被打印。

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

                  

<Socket name="server" host="10.140.254.54" port="12345" protocol="UDP"> <PatternLayout pattern="%d{MMM dd HH:mm:ss.SSS} %-5p %X{HostName} PRISM %X{AccountID}/%X{ApplicationID}/%X{SessionGUID}/%X{SessionNumber}/1/[%X{CallID}] [%t] %m%n" /> </Socket>

  3. loggers节点

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

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

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

   

1 <?xml version="1.0" encoding="UTF-8"?> 2 3 <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --> 4 5 <!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出--> 6 7 <!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数--> 8 9 <configuration status="WARN" monitorInterval="30"> 10 11 <!--先定义所有的appender--> 12 13 <appenders> 14 15 <!--这个输出控制台的配置--> 16 17 <console name="Console" target="SYSTEM_OUT"> 18 19 <!--输出日志的格式--> 20 21 <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> 22 23 </console> 24 25 <!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用--> 26 27 <File name="log" fileName="log/test.log" append="false"> 28 29 <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/> 30 31 </File> 32 33 <!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档--> 34 35 <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log" 36 37 filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log"> 38 39 <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)--> 40 41 <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/> 42 43 <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> 44 45 <Policies> 46 47 <TimeBasedTriggeringPolicy/> 48 49 <SizeBasedTriggeringPolicy size="100 MB"/> 50 51 </Policies> 52 53 </RollingFile> 54 55 <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log" 56 57 filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"> 58 59 <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/> 60 61 <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> 62 63 <Policies> 64 65 <TimeBasedTriggeringPolicy/> 66 67 <SizeBasedTriggeringPolicy size="100 MB"/> 68 69 </Policies> 70 71 <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20 --> 72 73 <DefaultRolloverStrategy max="20"/> 74 75 </RollingFile> 76 77 <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log" 78 79 filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"> 80 81 <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/> 82 83 <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> 84 85 <Policies> 86 87 <TimeBasedTriggeringPolicy/> 88 89 <SizeBasedTriggeringPolicy size="100 MB"/> 90 91 </Policies> 92 93 </RollingFile> 94 95 </appenders> 96 97 <!--然后定义logger,只有定义了logger并引入的appender,appender才会生效--> 98 99 <loggers> 100 101 <!--过滤掉spring和mybatis的一些无用的DEBUG信息--> 102 103 <logger name="org.springframework" level="INFO"></logger> 104 105 <logger name="org.mybatis" level="INFO"></logger> 106 107 <root level="all"> 其他logger输出所有的日志信息 108 109 <appender-ref ref="Console"/> 110 111 <appender-ref ref="RollingFileInfo"/> 112 113 <appender-ref ref="RollingFileWarn"/> 114 115 <appender-ref ref="RollingFileError"/> 116 117 </root> 118 119 </loggers> 120 121 </configuration>

 5、用户自定义级别日志CustomLevels

  这也是在项目里经常用到的,

1 <CustomLevels> 2 <CustomLevel name="USER" intLevel="350" /> 3 </CustomLevels> Standard log levels built-in to Log4J Standard LevelintLevelOFF0FATAL100ERROR200WARN300INFO400DEBUG500TRACE600ALLInteger.MAX_VALUE

 

 

转载于:https://www.cnblogs.com/shirley18/p/9618677.html

最新回复(0)