日志框架log4j2

Log4j2是log4j 1.x和logback的改进版，据说采用了一些新技术（无锁异步、等等），使得日志的吞吐量、性能比log4j 1.x提高10倍，并解决了一些死锁的bug，而且配置更加简单灵活。

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

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

② java项目中Classpath路径到底指的是哪里？

  1. src不是classpath,WEB-INF/classes,lib才是classpath，WEB-INF/是资源目录, 客户端不能直接访问。
  2. WEB-INF/classes目录存放src目录java文件编译之后的class文件，xml、properties等资源配置文件，这是一个定位资源的入口。
  3. lib和classes同属classpath，两者的访问优先级为: lib>classes。

配置文件详解

log4j2.xml文件的配置大致如下：

  • Configuration
    • properties
    • Appenders
      • Console
        • PatternLayout
      • File
      • RollingFile
      • Async
    • Loggers
      • Logger
      • Root
        • AppenderRef

缺省默认配置文件：

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

① Configuration：为根节点，有status和monitorInterval等多个属性

  • status的值有 “trace”, “debug”, “info”, “warn”, “error” and “fatal”，用于控制log4j2日志框架本身的日志级别，如果将stratus设置为较低的级别就会看到很多关于log4j2本身的日志，如加载log4j2配置文件的路径等信息。
  • monitorinterval：含义是每隔多少秒重新读取配置文件，可以不重启应用的情况下修改配置

② Appenders：输出源，用于定义日志输出的地方

log4j2支持的输出源有很多，有控制台Console、文件File、RollingFile、MongoDB、Flume 等。

1）Console：控制台输出源是将日志打印到控制台上，开发的时候一般都会配置，以便调试

  • name：Console的属性，指定Appender的名字；
  • target：Console的属性，SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT；
  • PatternLayout：Console的子节点，输出格式，不设置默认为：%m%n；

2）File：文件输出源，用于将日志写入到指定的文件，需要配置输入到哪个位置（例如：D:/logs/mylog.log）

  • name：File的属性，指定Appender的名字；
  • fileName：File的属性，指定输出日志的目的文件带全路径的文件名；
  • PatternLayout：File的子节点，输出格式，不设置默认为:%m%n；

3）RollingFile：用来定义超过指定大小自动删除旧的创建新的的Appender

  • name：RollingFile的属性，指定Appender的名字
  • fileName：RollingFile的属性，指定输出日志的目的文件带全路径的文件名
  • filePattern：RollingFile的属性，指定新建日志文件的名称格式.
  • PatternLayout：RollingFile的子节点，输出格式，不设置默认为:%m%n
  • DefaultRolloverStrategy：RollingFile的子节点，用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。
  • Policies：RollingFile的子节点，指定滚动日志的策略，就是什么时候进行新建日志文件输出日志
    • TimeBasedTriggeringPolicy：Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am
    • SizeBasedTriggeringPolicy：Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小
  • Filters：RollingFile的子节点，决定日志事件能否被输出。过滤条件有三个值：ACCEPT(接受), DENY(拒绝) or NEUTRAL(中立)
    • ThresholdFilter：Filters的子节点
      • level：ThresholdFilter的属性，将被过滤的级别。
      • onMatch：ThresholdFilter的属性，默认值是NEUTRAL
      • onMismatch：ThresholdFilter的属性，默认是DENY

ACCEP和DENY比较好理解就是接受和拒绝的意思，在使用单个过滤器的时候，一般就是使用这两个值。但是在组合过滤器中，如果用接受ACCEPT的话，日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以，在组合过滤器中，接受使用NEUTRAL（中立），被第一个过滤器接受的日志信息，会继续用后面的过滤器进行过滤，只有符合所有过滤器条件的日志信息，才会被最终写入日志文件。

4）NoSql：MongoDb, 输出到MongDb数据库中

5）Flume：输出到Apache Flume（Flume是Cloudera提供的一个高可用的，高可靠的，分布式的海量日志采集、聚合和传输的系统，Flume支持在日志系统中定制各类数据发送方，用于收集数据；同时，Flume提供对数据进行简单处理，并写到各种数据接受方（可定制）的能力。）

6）Async：异步，需要通过AppenderRef来指定要对哪种输出源进行异步（一般用于配置RollingFile）

PatternLayout：控制台或文件输出源（Console、File、RollingFile）都必须包含一个PatternLayout节点，用于指定输出文件的格式（如 日志输出的时间 文件 方法 行数 等格式），例如 pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"

%d{HH:mm:ss.SSS} 表示输出到毫秒的时间
%t 输出当前线程名称
%-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
%logger 输出logger名称，因为Root Logger没有名称，所以没有输出
%msg 日志文本
%n 换行

其他常用的占位符有：
%F 输出所在的类文件名，如Log4j2Test.java
%L 输出行号
%M 输出所在方法名
%l 输出语句所在的行数, 包括类名、方法名、文件名、行数

③ Loggers节点，常见的有两种：Root和Logger

1）Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出

  • level：Root属性，日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
  • appender-ref：Root的子节点，用来指定该日志输出到哪个Appender，通过ref指定

2）Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

  • level：Logger属性，日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
  • name：Logger属性，用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点
  • additivity：Logger属性
  • appender-ref：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

④ 日志级别

共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF

All：最低等级的，用于打开所有日志记录

Trace：是追踪，就是程序推进一下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出

Debug：指出细粒度信息事件对调试应用程序是非常有帮助的

Info：消息在粗粒度级别上突出强调应用程序的运行过程

Warn：输出警告及warn以下级别的日志

Error：输出错误信息日志

Fatal：输出每个严重的错误事件将会导致应用程序的退出的日志

OFF：最高等级的，用于关闭所有日志记录.

程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

实战配置：log4j2.xml

① 添加log4j2核心包



	org.apache.logging.log4j
	log4j-api
	2.7



	org.apache.logging.log4j
	log4j-core
	2.7

② log4j2.xml放到类路径下

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

③ 加载配置文件 

1）默认加载

默认名称的文件放在类路径即可。

2）纯Java

public static void main(String[] args) throws IOException {  
    File file = new File("D:/log4j2.xml");  
    BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));  
    final ConfigurationSource source = new ConfigurationSource(in);  
    Configurator.initialize(null, source);  
      
    Logger logger = LogManager.getLogger("myLogger");  
}

3）web指定路径加载

  
    log4jConfiguration  
    /WEB-INF/log4j2.xml  
  
  
  
    org.apache.logging.log4j.web.Log4jServletContextListener

上面用到了org.apache.logging.log4j.web.Log4jServletContextListener，需要引入另外一个包：


    org.apache.logging.log4j
    log4j-web
    2.7
日志框架

相关

日志框架

静态日志框架Extensioner.Logging

日志框架

Java日志框架SLF4J和log4j以及logback的联系和区别

spring-boot日志框架漏洞修复

日志框架体系整理

日志框架 SLF4J、JCL、JUL、log4j、logback的关系

标签