Log4j2 配置详解

1、到apache网站下载最新的log4j2的jar包，导入入log4j-api-2.0-beta5.jar和log4j-core-2.0-beta5.jar

 

2、用LogManager的getLogger函数获取一个logger，就可以使用logger记录日志，代码如下：

 

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class Test {
    private static Logger logger = LogManager.getLogger("HelloWorld");
    public static void main(String[] args){
        Test.logger.info("hello,world");
        Test.logger.error("There is a error here");
    }

}

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class HelloLog4j {
    private static Logger logger = LogManager.getLogger("HelloLog4j");
    public static void main(String[] args) {
        MyApplication myApplication =  new MyApplication();

        logger.entry();
        logger.info("Hello, World!");
        myApplication.doIt();
        logger.error("Hello, World!");
        logger.exit();
    }
}

 

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;


public class MyApplication {
    static Logger logger = LogManager.getLogger(MyApplication.class.getName());

    public boolean doIt() {
      logger.entry();   //Log entry to a method
      logger.error("Did it again!");   //Log a message object with the ERROR level
      logger.exit();    //Log exit from a method
      return false;
    }
}

运行结果为：

16:10:28.672 [main] ERROR MyApplication - Did it again!
16:10:28.672 [main] ERROR HelloLog4j - Hello, World!

注意到，输出的log都是在ERROR level上的，log4j定义了8个级别的log（除去OFF和ALL，可以说分为6个级别），优先级从高到低依次为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。如果将log level设置在某一个级别上，那么比此级别优先级高的log都能打印出来。例如，如果设置优先级为WARN，那么OFF、FATAL、ERROR、WARN 4个级别的log能正常输出，而INFO、DEBUG、TRACE、 ALL级别的log则会被忽略。从我们实验的结果可以看出，log4j默认的优先级为ERROR或者WARN（实际上是ERROR）。

 

log4j2的其配置文件只能采用.xml, .json或者 .jsn。在默认情况下，系统选择configuration文件的优先级如下：（classpath为src文件夹）System.setProperty("log4j.configurationFile", "配置文件名");

 

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为例来介绍log4j的配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </appenders>
  <loggers>
    <root level="trace">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

首先介绍loggers标签，用于定义logger的lever和所采用的appender，其中appender-ref必须为先前定义的appenders的名称，例如，此处为Console。那么log就会以appender所定义的输出格式来输出log。

root标签为log的默认输出形式，如果一个类的log没有在loggers中明确指定其输出lever与格式，那么就会采用root中定义的格式。例如以下定义：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </appenders>
  <loggers>
    <logger name="com.relin.HelloLog4j" level="error" additivity="false">
      <appender-ref ref="Console"/>
    </logger>
    <root level="trace">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

此时，HelloLog4j则会在error级别上输出log，而其他类则会在trace级别上输出log。需要注意的是 additivity选项，如果设置为true（默认值）则HelloLog4j的log会被打印两次，第二次打印是由于HelloLog4j同时也满足root里面定义的trace

其他

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="error">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
    </Console>
    <File name="log" fileName="target/test.log" append="false">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
    </File>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
      <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
      <SizeBasedTriggeringPolicy size="500 MB" />
    </RollingFile>
  </appenders>
  <loggers>
    <root level="trace">
      <appender-ref ref="RollingFile"/>
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

若是我们想去掉除com.foo.Bar以外所有的trace输出，我们可以增加一个新的注册事件，如下所示

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </appenders>
  <loggers>
    <logger name="com.foo.Bar" level="trace" additivity="false">
      <appender-ref ref="Console"/>
    </logger>
    <root level="error">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

 

扩展组件

1，ConsoleAppender

输出结果到System.out或是System.err。

2，FileAppender

输出结果到指定文件，同时可以指定输出数据的格式。append=“false”指定不追加到文件末尾

3，RollingFileAppender

自动追加日志信息到文件中，直至文件达到预定的大小，然后自动重新生成另外一个文件来记录之后的日志。

过滤标签

1，ThresholdFilter

用来过滤指定优先级的事件。

2，TimeFilter

设置start和end，来指定接收日志信息的时间区间

如何改变Log4j2的名称和路径？

如果想要改变默认的配置，那么就需要configuration file。Log4j的配置是写在log4j.properties文件里面，但是Log4j2就可以写在XML和JSON文件里了。

（1）放在classpath（src）下，以log4j2.xml命名

使用Log4j2的一般都约定俗成的写一个log4j2.xml放在src目录下使用。这一点没有争议。

（2）将配置文件放到别处

在系统工程里面，将log4j2的配置文件放到src目录底下很不方便。如果能把工程中用到的所有配置文件都放在一个文件夹里面，当然就更整齐更好管理了。但是想要实现这一点，前提就是Log4j2的配置文件能重新定位到别处去，而不是放在classpath底下。

可见，如果没有设置"log4j.configurationFile" system property的话，application将在classpath中按照如下查找顺序来找配置文件：

　　log4j2-test.json 或log4j2-test.jsn文件

　　log4j2-test.xml文件

　　log4j2.json 或log4j2.jsn文件

　　log4j2.xml文件

这就是为什么在src目录底下放log4j2.xml文件可以被识别的原因了。

如果想将配置文件重命名并放到别处，就需要设置系统属性log4j.configurationFile。

设置的方式是在VM arguments中写入该属性的key和value：

-Dlog4j.configurationFile="D:\learning\blog\20130115\config\LogConfig.xml"

在myeclipse中，就是 右键-》run as -》run configuration-》右边窗口的“（x）=argument”=》VM arguments

然后写入上述key和value即可。

-D是参数，不能缺少。

或在程序中设置：

System.setProperty("log4j.configurationFile", "配置文件名");

例如,编辑配置文件

然后在myeclipse设置VM参数