Apache Log4j 2安装与配置

Apache Log4j 2

官网地址: https://logging.apache.org/log4j/2.x/

class HelloWorld {  
    public static void main(String args[]) {  
        System.out.println("Hello World...");  
    }  
}

Java版本:

$ java -version
java version "1.8.0_144"
Java(TM) SE Runtime Environment (build 1.8.0_144-b01)
Java HotSpot(TM) 64-Bit Server VM (build 25.144-b01, mixed mode)

Eclispe 版本:

Version: Oxygen.2 Release (4.7.2)

Eclispe添加JAR包

菜单栏点击【Project】 -> 点击【Properties】-> 在弹框中选择【Java Build Path】-> 点击【Add External JREs Libraries】

添加以下两个jar包即可:

log4j-api-2.10.0.jar
log4j-core-2.10.0.jar

Java代码

Log4jDemo.java 代码:

// Log4jDemo.java
//import org.apache.log4j.*;
import org.apache.logging.log4j.*;

public class Log4jDemo {
    static Logger logger = LogManager.getLogger(Log4jDemo.class);
    public static void main(String[] args) {
        System.out.println("Hello Log4jDemo...");
        logger.trace("trace level");
        logger.debug("debug level");
        logger.info("info level");
        logger.warn("warn level");
        logger.error("error level");
        logger.fatal("fatal level");
    }
}

日志的级别

在log4j2中，一共有五种log level，分别为: TRACE < DEBUG < INFO < WARN < ERROR < FATAL。

　　FATAL：致命错误。用在极端的情形中，即必须马上获得注意的情况。这个程度的错误通常需要触发运维工程师的寻呼机。

　　ERROR：显示一个错误，或一个通用的错误情况，但还不至于会将系统挂起。这种程度的错误一般会触发邮件的发送，将消息发送到alert list中，运维人员可以在文档中记录这个bug并提交。

　　WARN：不一定是一个bug，但是有人可能会想要知道这一情况。如果有人在读log文件，他们通常会希望读到系统出现的任何警告。

　　INFO：用于基本的、高层次的诊断信息。在长时间运行的代码段开始运行及结束运行时应该产生消息，以便知道现在系统在干什么。但是这样的信息不宜太过频繁。

　　DEBUG：用于协助低层次的调试。

　　TRACE：用于展现程序执行的轨迹。

注意：级别之间是包含的关系，如果设置日志级别是trace，则大于等于这个级别的日志都会输出。

如果设置日志级别为 warn, 则只有 warn/error/fatal 三种级别会输出。
如果设置日志级别为 fatal, 则只有 fatal 级别会输出。

日志调用

执行上面的demo，会报如下错误，且只会打印 error、fatal 级别的日志信息。 因为没有配置log4j2的配置文件，会使用系统默认的配置文件。

ERROR StatusLogger No log4j2 configuration file found. 
Using default configuration: logging only errors to the console. 
Set system property 'log4j2.debug' to show Log4j2 internal initialization logging.
Hello Log4jDemo...
14:15:02.002 [main] ERROR Log4jDemo - error level
14:15:02.005 [main] FATAL Log4jDemo - fatal level

日志配置

log4j2的配置文件后缀名只能为 .xml, .json 或者 .jsn。建议使用 log4j2.xml 该配置文件进行配置，注意文件名固定值 log4j2.xml。

配置log4j2.xml文件:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
    </Appenders>
    <Loggers>
        <root level="TRACE">
            <appender-ref ref="Console" />
        </root>
    </Loggers>
</Configuration>  

控制台会输出以下内容:

=> Hello Log4jDemo...
18-01-25 14:53:15.482 [main] TRACE test.log4j.Log4jDemo - trace level
18-01-25 14:53:15.487 [main] DEBUG test.log4j.Log4jDemo - debug level
18-01-25 14:53:15.487 [main] INFO  test.log4j.Log4jDemo - info level
18-01-25 14:53:15.487 [main] WARN  test.log4j.Log4jDemo - warn level
18-01-25 14:53:15.487 [main] ERROR test.log4j.Log4jDemo - error level
18-01-25 14:53:15.487 [main] FATAL test.log4j.Log4jDemo - fatal level

PatternLayout是日志文件的布局格式

常用的参数如下：

　　%d：打印时间，常用设置：{HH:mm:ss.SSS} {yyyy-MM-dd ‘at’ HH:mm:ss z}等

　　%class/%c：打印输出日志的类名，常用设置{36} 表示层数

　　%level：打印日志级别 ，常用设置%-5level 表示日志的级别长度小于5，则右边用空格填充 ；%5level 相反。

　　%L：打印日志输出语句在文件中的行号。

　　%M：打印日志输出语句所在的方法名。

　　%t：当前生成日志事件的线程。

　　%m/%msg/%message：输出日志事件所提供的信息。

参考

http://www.cnblogs.com/hong-fithing/p/7694196.html
https://logging.apache.org/log4j/2.x/manual/migration.html

更新记录

2018-01-23 参考网上资料，联系此功能点，同时记录此文内容
2018-01-25 整理文章格式，完善内容

[END]