Log4j2配置详解

根结点

根节点Configuration有两个属性:status和monitorinterval，有两个子节点:Appenders和Loggers（appenders节点是定义日志输出方式，loggers节点是指明哪些日志输出到哪些appenders中）。另外，Configuration节点下也可以定义properties，以供其它配置引用

  • status用来指定log4j本身的打印日志的级别
  • monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.
<?xml version="1.0" encoding="UTF-8"?>
<configuration status="info">
    <properties>
        <property name="pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} - - [%p] %c{1}.%M:%L %XMDT %msg%n</property>
    </properties>
  
    <appenders>
            ...
    </appenders>

    <loggers>
      ...
    </loggers>
</configuration>

Appenders节点

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

  • Console节点用来定义输出到控制台的Appender.
    1.name:指定Appender的名字.
    2.target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
    3.PatternLayout:输出格式，不设置默认为:%m%n.

  • File节点用来定义输出到指定位置的文件的Appender.
    1.name:指定Appender的名字.
    2.fileName:指定输出日志的目的文件带全路径的文件名.
    3.PatternLayout:输出格式，不设置默认为:%m%n.

  • RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.
    1.name:指定Appender的名字.
    2.fileName:指定输出日志的目的文件带全路径的文件名.
    3.PatternLayout:输出格式，不设置默认为:%m%n.
    4.filePattern:指定新建日志文件的名称格式.
    5.Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
    6.TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.
    7.SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
    8.DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

    Log4j提供的layout有以下4种：

       1. org.apache.log4j.HTMLLayout(以HTML表格形式布局)选项：

                LocationInfo=true:默认值是false,输出java文件名称和行号。

                Title=my app file: 默认值是 Log4J Log Messages。

       2. org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)

       3. org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

       4. org.apache.log4j.XMLLayout(以XML形式布局)选项：

                 LocationInfo=true:默认值是false,输出java文件和行号。

       5. org.apache.log4j.PatternLayout(可以灵活地指定布局模式），如果使用PatternLayout布局就要指定的打印信息的具体格式ConversionPattern,打印参数如下：

            %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

            %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

            %r: 输出自应用启动到输出该log信息耗费的毫秒数

            %c: 输出日志信息所属的类目，通常就是所在类的全名

            %t: 输出产生该日志事件的线程名

            %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

            %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

            %%: 输出一个"%"字符

            %F: 输出日志消息产生时所在的文件名称

            %L: 输出代码中的行号

            %m: 输出代码中指定的消息,产生的日志具体信息

            %n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行

            可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

            1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。

            2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。

            3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。

            4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。

Loggers节点

Loggers节点的子节点常见的有两种:Root和Logger。

  • Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
    1.level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
    2.AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender
  • Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
    1.level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
    2.name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点
    3.AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender，如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出

示例

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="WARN" monitorInterval="30">
     <!--先定义所有的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">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容