先来一个较全的模板
<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置-->
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
<!-- 优先级从高到低分别是 OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL -->
<!-- 单词解释: Match:匹配 DENY:拒绝 Mismatch:不匹配 ACCEPT:接受 -->
<!-- DENY,日志将立即被抛弃不再经过其他过滤器; NEUTRAL,有序列表里的下个过滤器过接着处理日志; ACCEPT,日志会被立即处理,不再经过剩余过滤器。 -->
<configuration status="WARN" monitorInterval="30">
<!--定义log文件输出路径(工程所在盘符下)-->
<Properties>
<Property name="log-path">/log4j2/logs</Property>
</Properties>
<!--先定义所有的appender-->
<appenders>
<!--输出到控制台 如果是部署到tomcat下,这部分内容会输出到tomcat下的tomcat8-stdout.yyyy-mm-dd.log文件中-->
<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式-->
<PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
</console>
<!--打印到文件中,这个log每次运行程序会自动清空,由append属性决定false清空,true追加。 一般不用-->
<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="${log-path}/info.log"
filePattern="${log-path}/info_%d{yyyy-MM-dd}-%i.log">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<Filters>
<ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
<PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>
<Policies>
<!--文件夹下最多的文件个数-->
<DefaultRolloverStrategy max="20"/>
<!--多长时间滚动一次-->
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<!-- 一个日志文件的最大大小 -->
<SizeBasedTriggeringPolicy size="100 MB"/>
</Policies>
</RollingFile>
<!--设置另一个log文件-->
<RollingFile name="FileDetail" fileName="${log-path}/infoDetail.log"
filePattern="${log-path}/infoDetail_%d{yyyy-MM-dd}-%i.log">
<PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<SizeBasedTriggeringPolicy size="50 MB"/>
</Policies>
<DefaultRolloverStrategy max="30">
<Delete basePath="${log-path}" maxDepth="1">
<IfFileName glob="infoDetail_*.log"/>
<IfLastModified age="15d"/>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
</appenders>
<!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
<loggers>
<!--关联FileDetail,com.lianxi.detail包下的类输出的log都输出到FileDetail的Appender指定文件-->
<logger level="debug" name="com.lianxi.detail">
<AppenderRef ref="FileDetail"/>
</logger>
<!--没有关联的,com.lianxi包下的类输出的log都输出到RollingFileInfo的Appender指定文件-->
<logger level="debug" name="com.lianxi"></logger>
<root level="all">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
</root>
</loggers>
</configuration>
配置文件节点解析
1.根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).
status用来指定log4j本身的打印日志的级别.
monitorinterval用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.
2.Appenders节点,常见的有三种子节点:Console、RollingFile、File.
Console节点用来定义输出到控制台的Appender.
name:指定Appender的名字.
target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
PatternLayout:输出格式,不设置默认为:%m%n.
File节点用来定义输出到指定位置的文件的Appender.
name:指定Appender的名字.
fileName:指定输出日志的目的文件带全路径的文件名.
PatternLayout:输出格式,不设置默认为:%m%n.
RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.
name:指定Appender的名字.
fileName:指定输出日志的目的文件带全路径的文件名.
PatternLayout:输出格式,不设置默认为:%m%n.
filePattern:指定新建日志文件的名称格式.
Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.
SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性),默认是7个文件。
3.Loggers节点,常见的有两种:Root和Logger.
Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出
level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
AppenderRef:Root的子节点,用来指定该日志输出到哪个Appender.
Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。
level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。
4.关于日志level.
共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
All:最低等级的,用于打开所有日志记录.
Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低日志级别不让他输出.
Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
Info:消息在粗粒度级别上突出强调应用程序的运行过程.
Warn:输出警告及warn以下级别的日志.
Error:输出错误信息日志.
Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
OFF:最高等级的,用于关闭所有日志记录.
输出格式
格式 | 说明 |
---|---|
%d | 日志产生时间,{<日期格式>}使用ISO8601定义的日期格式 |
%p | 显示该条日志的优先级,如INFO,DEBUG等 |
%c | logger的名称,列出logger名字空间的全称,如果加上{<层数>}表示列出从最内层算起的指定层数的名字空间 |
%m | 日志内容,即 logger.info("message") |
%M | 显示调用logger的方法名 |
%n | 当前平台下的换行符 |
%C | Java类名,列出调用logger的类的全名(包含包路径) |
%L | 日志输出调用logger的代码所在行数 |
%F | 显示调用logger的源文件名 |
%I | 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数 |
%r | 显示从程序启动时到记录该条日志时已经经过的毫秒数 |
%t | 输出产生该日志事件的线程名 |
%x | 按NDC(Nested Diagnostic Context,线程堆栈)顺序输出日志 |
%X | 按MDC输出日志。通常用于多个客户端连接同一台服务器,方便服务器区分是那个客户端访问留下来的日志。 |
%M | 日志输出所在方法名 |
hostName | 本地机器名 |
hostAddress | 本地ip地址 |
log4j2 动态生成logger,每个logger一个输出文件
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.appender.RollingFileAppender;
import org.apache.logging.log4j.core.appender.rolling.CompositeTriggeringPolicy;
import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy;
import org.apache.logging.log4j.core.appender.rolling.SizeBasedTriggeringPolicy;
import org.apache.logging.log4j.core.appender.rolling.TimeBasedTriggeringPolicy;
import org.apache.logging.log4j.core.appender.rolling.action.*;
import org.apache.logging.log4j.core.config.AppenderRef;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.LoggerConfig;
import org.apache.logging.log4j.core.filter.ThresholdFilter;
import org.apache.logging.log4j.core.layout.PatternLayout;
import java.io.File;
/**
* @author
* @description: 日志打印工具类
* @date
*/
public class LogUtil {
/**
* 日志打印的目录
*/
private static final String LOGDIR = "/midware/app/logs";
/**
* Logger Context对象
*/
private static final LoggerContext CTX = (LoggerContext) LogManager.getContext(false);
/**
* Configuration对象
*/
private static final Configuration CONFIG = CTX.getConfiguration();
/**
* 启动一个动态的logger
*
* @param loggerName
* @return
*/
private static void start(String loggerName) {
//创建一个展示的样式:PatternLayout, 还有其他的日志打印样式。
PatternLayout layout = PatternLayout.newBuilder()
.withConfiguration(CONFIG)
.withPattern("[%d] [%thread] %-5p %c %m%n")
.build();
//单个日志文件大小
TimeBasedTriggeringPolicy tbtp = TimeBasedTriggeringPolicy.newBuilder()
.withInterval(1)//轮询时间 这里代表一天执行一次。时间依据filePattern的配置-
.withModulate(true)
.build();
// 大小分割
SizeBasedTriggeringPolicy tp = SizeBasedTriggeringPolicy.createPolicy("10 MB");
CompositeTriggeringPolicy policyComposite = CompositeTriggeringPolicy.createPolicy(tbtp, tp);
String loggerDir = LOGDIR + File.separator + "test-" + loggerName;
//删除日志条件
//根据文件名删除
IfFileName ifFileName = IfFileName.createNameCondition(null, loggerDir + ".test.*");
//根据时间删除 此处删除15天前的文件 单位需要和filePattern精确的时间一致, 否则无效.
IfLastModified ifLastModified = IfLastModified.createAgeCondition(Duration.parse("15d"));
DeleteAction deleteAction = DeleteAction.createDeleteAction(
loggerDir, false, 1, false, null,
new PathCondition[]{ifLastModified, ifFileName}, null, CONFIG);
Action[] actions = new Action[]{deleteAction};
DefaultRolloverStrategy strategy = DefaultRolloverStrategy.newBuilder()
.withCustomActions(actions)
.withMax("30")
.withConfig(CONFIG)
.build();
ThresholdFilter infoFilter = ThresholdFilter.createFilter(Level.INFO, Filter.Result.ACCEPT, Filter.Result.DENY);
ThresholdFilter errorFilter = ThresholdFilter.createFilter(Level.ERROR, Filter.Result.ACCEPT, Filter.Result.NEUTRAL);
RollingFileAppender appender = RollingFileAppender.newBuilder()
.withFileName(loggerDir + ".log")
.withFilePattern(loggerDir + ".%d{yyyy-MM-dd}.%i.log.gz")//日志文件后缀精确的时间决定了生成日志文件的频次
.withAppend(true)
.withPolicy(policyComposite)
.withStrategy(strategy)
.setName(loggerName)
.setFilter(infoFilter)
.setFilter(errorFilter)
.setLayout(layout)
.setConfiguration(CONFIG)
.build();
appender.start();
CONFIG.addAppender(appender);
AppenderRef ref = AppenderRef.createAppenderRef(loggerName, null, null);
AppenderRef[] refs = new AppenderRef[]{ref};
LoggerConfig loggerConfig = LoggerConfig.createLogger(false,
Level.INFO, loggerName, "true", refs, null, CONFIG, null);
loggerConfig.addAppender(appender, Level.INFO, null);
CONFIG.addLogger(loggerName, loggerConfig);
CTX.updateLoggers();
}
/**
* 使用完关闭动态创建的logger,避免内存不够用或者文件打开太多
*
* @param loggerName
* @return
*/
public static void stop(String loggerName) {
synchronized (CONFIG) {
CONFIG.getAppender(loggerName).stop();
CONFIG.getLoggerConfig(loggerName).removeAppender(loggerName);
CONFIG.removeLogger(loggerName);
CTX.updateLoggers();
}
}
/**
* 获取Logger
*
* @param loggerName
* @return
*/
public static Logger getLogger(String loggerName) {
synchronized (CONFIG) {
if (!CONFIG.getLoggers().containsKey(loggerName)) {
start(loggerName);
}
}
return LogManager.getLogger(loggerName);
}
}