Log4j2详细介绍
一、log4j、logback、log4j2介绍
- log4j是apache实现的一个开源日志组件
- logback同样是由log4j的作者设计完成的，拥有更好的特性，用来取代log4j的一个日志框架，是slf4j的原生实现
- Log4j2是log4j 1.x和logback的改进版，据说采用了一些新技术（无锁异步、等等），使得日志的吞吐量、性能比log4j 1.x提高10倍，并解决了一些死锁的bug，而且配置更加简单灵活
了解一下，使用slf4j+log4j和直接用log4j的区别
slf4j是对所有日志框架制定的一种规范、标准、接口，并不是一个框架的具体的实现，因为接口并不能独立使用，需要和具体的日志框架实现配合使用（如log4j、logback），使用接口的好处是当项目需要更换日志框架的时候，只需要更换jar和配置，不需要更改相关java代码。
log4j、logback、log4j2都是一种日志具体实现框架，所以既可以单独使用也可以结合slf4j一起搭配使用。
如下面的是直接使用log4j。
import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; public class TestLog4j { // Logger和LogManager导入的是org.apache.logging包 private static final Logger LOG = LogManager.getLogger(TestLog4j.class); }
二、log4j2的使用介绍
1、导入需要使用的jar包(slf4j+log4j2)
springboot项目中需导入:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>
绕坑：如项目中有导入spring-boot-starter-web依赖包记得去掉spring自带的日志依赖spring-boot-starter-logging，如下：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency>
2、开始配置
springboot方式：
application.properties中添加配置 logging.config=classpath:log4j2_dev.xml， log4j2_dev.xml是你创建的log4j2的配置文件名，放在resources下，如放在其他路径则对应修改
配置文件的格式：log2j配置文件可以是xml格式的，也可以是json格式的，
配置文件的位置：log4j2默认会在classpath目录下寻找log4j2.xml、log4j.json、log4j.jsn等名称的文件，如果都没有找到，则会按默认配置输出，也就是输出到控制台，也可以对配置文件自定义位置（需要在web.xml中配置），一般放置在src/main/resources根目录下即可
贴上log4j2_dev.properties的配置再来讲解
<?xml version="1.0" encoding="UTF-8"?> <!--设置log4j2的自身log级别为warn--> <!--日志级别以及优先级排序: 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/hpaasvc/info.log" filePattern="${sys:user.home}/logs/hpaasvc/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log"> <!-- level 日志级别 onMatch 符合日志级别的处理情况 onMisMatch 不符合日志级别的处理情况 ACCEPT 接受打印 DENY 拒绝打印 NEUTRAL 不做处理 即忽略此 filter 看看下面有没有能够处理的规则 以下两条翻译： 在warn及以上的级别都不打印，其他的不做处理 > WARN\ERROR\FATAL被过滤删除 只剩TRACE\DEBUG\INFO 在info及以上的都打印，其他的不打印 > RACE\DEBUG被过滤删除 只剩下info被打印 所以要注意Filter的执行顺序 --> <Filters> <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）--> <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/> <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/> </Filters> <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/hpaasvc/warn.log" filePattern="${sys:user.home}/logs/hpaasvc/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"> <Filters> <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/> <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/> </Filters> <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/hpaasvc/error.log" filePattern="${sys:user.home}/logs/hpaasvc/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"> <ThresholdFilter level="ERROR"/> <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> <!-- additivity="false"表示在该logger中输出的日志不会再延伸到父层logger --> <!--过滤掉spring和hibernate的一些无用的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>
异步日志：
<?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <properties> <property name = "LOG_HOME">D:/logs</property> <property name = "INFO_NAME">info</property> <property name = "DEBUG_NAME">debug</property> <property name = "ERROR_NAME">error</property> <property name = "LOG_NAME">log</property> </properties> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" /> </Console> <RollingRandomAccessFile name="MyFile" fileName="${LOG_HOME}/${LOG_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${LOG_NAME}-%d{yyyy-MM-dd}-%i.log"> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" /> <Policies> <TimeBasedTriggeringPolicy interval="1" /> <SizeBasedTriggeringPolicy size="10 MB" /> </Policies> <DefaultRolloverStrategy max="20" /> </RollingRandomAccessFile> <Async name="myAsync"> <AppenderRef ref="MyFile" /> </Async> </Appenders> <Loggers> <Logger name="myLog" level="trace" additivity = "false"> <AppenderRef ref="myAsync"/> </Logger> <Root level="error"> <AppenderRef ref="Console" /> </Root> </Loggers> </Configuration>
log4j2.xml文件的配置大致如下：
- Configuration
- properties
- Appenders
- Console
- PatternLayout
- File
- RollingRandomAccessFile
- Async
- Console
- Loggers
- Logger
- Root
- AppenderRef
-
Configuration：为根节点，有status和monitorInterval等多个属性
- status的值有 “trace”, “debug”, “info”, “warn”, “error” and “fatal”，用于控制log4j2日志框架本身的日志级别，如果将stratus设置为较低的级别就会看到很多关于log4j2本身的日志，如加载log4j2配置文件的路径等信息
- monitorInterval，含义是每隔多少秒重新读取配置文件，可以不重启应用的情况下修改配置
-
Appenders：输出源，用于定义日志输出的地方
log4j2支持的输出源有很多，有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume 等-
Console：控制台输出源是将日志打印到控制台上，开发的时候一般都会配置，以便调试
-
File：文件输出源，用于将日志写入到指定的文件，需要配置输入到哪个位置（例如：D:/logs/mylog.log）
-
RollingRandomAccessFile: 该输出源也是写入到文件，不同的是比File更加强大，可以指定当文件达到一定大小（如20MB）时，另起一个文件继续写入日志，另起一个文件就涉及到新文件的名字命名规则，因此需要配置文件命名规则
这种方式更加实用，因为你不可能一直往一个文件中写，如果一直写，文件过大，打开就会卡死，也不便于查找日志。- fileName 指定当前日志文件的位置和文件名称
- filePattern 指定当发生Rolling时，文件的转移和重命名规则
- SizeBasedTriggeringPolicy 指定当文件体积大于size指定的值时，触发Rolling
- DefaultRolloverStrategy 指定最多保存的文件个数
- TimeBasedTriggeringPolicy 这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i，最小的时间粒度是mm，即分钟
- TimeBasedTriggeringPolicy指定的size是1，结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，则每一个小时生成一个文件
-
NoSql：MongoDb, 输出到MongDb数据库中
-
Flume：输出到Apache Flume（Flume是Cloudera提供的一个高可用的，高可靠的，分布式的海量日志采集、聚合和传输的系统，Flume支持在日志系统中定制各类数据发送方，用于收集数据；同时，Flume提供对数据进行简单处理，并写到各种数据接受方（可定制）的能力。）
-
Async：异步，需要通过AppenderRef来指定要对哪种输出源进行异步（一般用于配置RollingRandomAccessFile）
PatternLayout：控制台或文件输出源（Console、File、RollingRandomAccessFile）都必须包含一个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和自定义日志器，当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器，自定义时需要指定每个Logger的名称name（对于命名可以以包名作为日志的名字，不同的包配置不同的级别等），日志级别level，相加性additivity（是否继承下面配置的日志器）， 对于一般的日志器（如Console、File、RollingRandomAccessFile）一般需要配置一个或多个输出源AppenderRef；每个logger可以指定一个level（TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF），不指定时level默认为ERROR
additivity指定是否同时输出log到父类的appender，缺省为true。
-
<Logger name="rollingRandomAccessFileLogger" level="trace" additivity="true">
-
<AppenderRef ref="RollingRandomAccessFile" />
-
</Logger>
- properties: 属性
使用来定义常量，以便在其他配置的时候引用，该配置是可选的，例如定义日志的存放位置
D:/logs
三、特性
关于log4j2的新特性
丢数据这种情况少，可以用来做审计功能。而且自身内部报的exception会被发现，但是logback和log4j不会。
log4j2使用了disruptor技术，在多线程环境下，性能高于logback等10倍以上。
(garbage free）之前的版本会产生非常多的临时对象，会造成GC频繁，log4j2则在这方面上做了优化，减少产生临时对象。尽可能少的GC
利用插件系统，使得扩展新的appender,filter,layout等变得容易，log4j不可以扩展 插件？？？？
因为插件系统的简单性，所以在配置的时候，可以不用具体指定所要处理的类型。class
可以自定义level
Java 8 lambda support for lazy logging
Support for Message objects
对filter的功能支持的更强大
系统日志(Syslog)协议supports both TCP and UDP
利用jdk1.5并发的特性，减少了死锁的发生。
Socket LogEvent SerializedLayout
支持kafka queue
四、问题：
1. 日志不按小时滚动
原来的配置如下：
<RollingRandomAccessFile name="RollingFile" fileName="${backupFilePatch}${fileName}" filePattern="${backupFilePatch}${fileName}.%d{yyyy-MM-dd}.%i" immediateFlush="false">
<PatternLayout pattern="%d{HH:mm:ss.SSS} %p %c{1}[%L]-%m%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
</Policies>
<DefaultRolloverStrategy max="120"/>
</RollingRandomAccessFile>
根据官网的介绍，我理解成了interval=1的时候固定按小时滚动，其实interval的单位是根据filePattern来的，即filePattern配置中的最小单位，所以在yyyy-MM-dd这样的配置中，interval的单位是day，而%i则是interval的序号，日志是按天滚动的。所以将配置改为${backupFilePatch}${fileName}.%d{yyyy-MM-dd.HH}就能按小时滚动了。
2. 每小时滚动后，日志不写入新文件，而是写入旧的归档文件。
这个问题更诡异。tomcat启动后，日志是写入log文件的，但是整点日志滚动之后，log归档为log-日期，产生一个新的log文件，但日志还是打入了归档之后的文件log-日期。放置了一天之后，发现更诡异的事情，日志总是写入上一个归档文件。例如，7点的时候，产生一个归档文件log-日期.6，7点到8点的日志都打入了文件6，log文件始终是空的，而8点之后，log归档为log-日期-7，之后的日志都打入文件7，新产生的log文件还是为空。
该问题遍寻不着解法。在某一次整点时，正好刷新了一下，发现log文件有新内容，再刷新又成为上面那种现象了。由此联想到，有可能不只是log4j2在对这个文件进行操作。
排查发现，改写log4j2.xml之后，原来的log4j.properties还留在项目里。由于maven层层叠叠的依赖，有几个包引用的是log4j1.x版本，在运行的时候，始终有一个包用的是log4j1.x在打日志，因此加载的是log4j.properties的配置。log4j.properties和log4j2.xml的配置完全相同，写入的也是同一个日志文件。整点的时候，这两个类都对log文件进行归档操作，猜想是log4j2先执行归档，写入新log文件，而这个文件又被log4j1归档，因此后面log4j2的日志都写入了上一个归档文件。
将log4j.properties中的日志改为其他名称，问题解决。
