log4j2常用配置

1.概述

JAVA常用的日志收集api和实现框架都有多种，不同的api和实现框架之间怎么相互兼容都比较复杂，不过大部分的日志框架实现也都提供了对其他日志收集方式的兼容和切换（可以参考https://my.oschina.net/pingpangkuangmo/blog/410224）。本文主要介绍log4j2的Appenders下的组件列表，及几种比较常见的appender配置。

2.配置详解

log4j2.xml文件结构如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<Configuration>
	<Properties>
		...
	</Properties>

	<Appenders>
		...
	</Appenders>

	<Loggers>
		...
	</Loggers>
</Configuration>

配置文件由Properties、Appenders、Loggers三块组成。Properties配置基础变量，Loggers负责配置日志级别，Loggers配置日志收集方式、布局、输出、清理等功能。

2.1. appender组件列表

2.2.ConsoleAppender

ConsoleAppender比较简单，就是把日志写入System.out或者System.err中，基本配置如下：

<Console name="STDOUT" target="SYSTEM_ERR">
	<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %t %5p [%c:%L] - %m%n" />
</Console>

Console一般使用基本配置就可以，唯一要注意的就是输出格式pattern，pattern的配置释义如下：

参数	描述
%c或%logger	输出logName，如 Logger log = LoggerFactory.getLogger(“com.test.logName”); 则输出为“com.test.logName” ，如果格式为%c{参数}，则输出内容参考官网：
%C或%class	输出为所在类的全路径名
d{pattern}或date{pattern}	输出时间，其中pattern可以是保留字，也可以是SimpleDateFormat中的字符。如 %d{DEFAULT} --> 2012-11-02 14:34:02,781 %d{DEFAULT_MICROS} --> 2012-11-02 14:34:02,123456 %d{yyyy-MM-dd HH:mm:ss.SSS} --> 2020-03-31 23:25:13.321 详见log4j PatternLayout
%F或%file	输出所在类名.java，如所在类为com.test.LogTest，则输出为LogTest.java
%l	输出错误的完整位置，全路径类名.方法名(类名.java:行号)，如，com.test.LogTest.testLog(LogTest.java:31)
%L	输出行号
%m或%msg或%message	输出log.error(text)中的text内容
%M或%method	输出方法名
%n	换行符
%t或%thread	输出线程名
%u{“RANDOM” | “TIME”}或uuid	输出uuid
%sn或%sequenceNumber	输出自增序列
%r或%relative	输出从JVM启动到当前时刻的毫秒数
%T或%tid或%threadId	输出线程id
%t或%tn或%thread或%threadName	输出线程id
%tp或%threadPriority	输出线程优先级

2.3.RollingFileAppender

RollingFileAppender是一个OutputStreamAppender，可以根据TriggeringPolicy和RolloverPolicy将文件切割归档，通过RollingFileManager（扩展了OutputStreamManager）来实际执行文件I / O并执行归档。参数如下：

2.3.1.TriggeringPolicy

TriggeringPolicy是控制日志文件归档的触发条件。总共有四种类型的TriggeringPolicy，可以组合（CompositeTriggeringPolicy）多种触发策略来控制归档，标签为<Policies>，如果配置了多种策略，则只要有一种策略返回true，就返回true。

<Policies>
  <!-- <CronTriggeringPolicy schedule="0 0 * * * ?"/> -->
  <OnStartupTriggeringPolicy minSize="2" />
  <SizeBasedTriggeringPolicy size="20 MB" />
  <TimeBasedTriggeringPolicy />
</Policies>

四种类型如下：

• OnStartupTriggeringPolicy
  如果日志文件的时间比JVM的启动时间早，或者达到minSize的值，则会触发归档。
  minSize：触发文件归档的最小值，默认为1。
• SizeBasedTriggeringPolicy
  当文件达到指定大小后，触发归档。大小可以通过size指定，单位为KB、MB、GB。与TimeBasedTriggeringPolicy配合使用时，filePattern中必须包含%i，否则文件每次归档时都会覆盖当前文件，因为TimeBasedTriggeringPolicy不会让文件名中的时间戳改变。如果不使用TimeBasedTriggeringPolicy，则SizeBasedTriggeringPolicy会让时间戳改变。
• TimeBasedTriggeringPolicy
  当前时间与当前日志文件时间不匹配时，TimeBasedTriggeringPolicy会触发归档。参数如下：

• CronTriggeringPolicy
  基于cron表达式触发归档。此策略由计时器控制，并且与处理日志事件异步，因此上一个或下一个时间段的日志事件可能会出现在当前日志文件的开头或结尾。filePattern属性应包含一个时间戳，否则目标文件将在每次归档时被覆盖。参数如下：

2.3.2.RolloverPolicy

用来控制文件归档方式，目前有两种类型如下：

2.3.2.1.DefaultRolloverStrategy

通过接收filePattern属性中日期/时间模式（%d）和整数（%i）来控制归档方式。如果存在日期/时间模式，则将在归档时使用当前时间替换filePattern中配置的日期/时间部分，如果模式包含整数，则它将在每次归档时递增。如果归档时在模式中同时包含日期/时间和整数，则整数将递增，直到日期/时间部分也将被替换。如果文件模式以“ .gz”，“.zip”，“.bz2”，“.deflate”，“.pack200”或“ .xz”结尾，则将使用与后缀匹配的压缩方案来压缩文件。 bzip2, Deflate, Pack200 and XZ格式要求有Apache Commons Compress组件，另外xz格式还要求有XZ for Java组件。
DefaultRolloverStrategy参数如下：

fileIndex设值不同，则文件归档及新文件创建及计数器递增方法都不同，计数器递增有三种方式，如下：

• 方式一：fileIndex值为max
  假设将DefaultRolloverStrategy的min属性设置为1，将max属性设置为3，fileName是“ foo.log”，filePattern是“ foo-％i.log”,归档规则如下：

• 方式二：fileIndex值为min

假设将DefaultRolloverStrategy的min属性设置为1，将max属性设置为3，fileName是“ foo.log”，filePattern是“ foo-％i.log”,归档规则如下：

• 方式三：fileIndex值为nomax
  nomax为2.8新增属性，设置为nomax时，将忽略DefaultRolloverStrategy的最大值和最小值，每次归档生成的新文件相对于前一个文件编号加1，没有最大文件数限制。

2.3.2.2.DirectWriteRolloverStrategy

将日志事件直接写入由filePattern表示的文件。使用此策略文件不会执行重命名。如果是基于大小的触发策略，将在指定的时间段内写入多个文件，它们从1开始编号，并不断递增直到发生基于时间归档。
注意：如果filePattern的后缀表示应该进行压缩，则在关闭应用程序时不会压缩当前文件。此外，如果时间更改使得filePattern不再与当前文件匹配，则启动时也不会对其进行压缩。
DirectWriteRolloverStrategy模式参数如下：

2.3.2.3.归档保留策略

DefaultRolloverStrategy模式下，Log4j-2.5引入了Delete（删除）操作（标签为<delete>），与 max属性所提供的功能相比，Log4j-2.5使用户可以更好地控制在归档时删除哪些文件。删除操作使用户可以配置一个或多个条件，以选择要相对于基本目录删除的文件。

注意：可以删除任何文件，而不仅仅是删除日志文件，因此请谨慎使用此操作！使用testMode参数，可以测试配置，而不会意外删除错误的文件。
delete参数如下：

3.日志归档+日志清理配置demo

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<Configuration status="WARN">
	<Properties>
		<Property name="logDir">/export/Logs/meeting/</Property>
		<Property name="logFile">gltLog</Property>
	</Properties>

	<Appenders>
		<Console name="STDOUT" target="SYSTEM_ERR">
			<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %t %5p [%c:%L] - %m%n" />
		</Console>

		<!--日志名称及归档的压缩包名称及规则-->
		<RollingFile name="RollingFile" fileName="${logDir}/${logFile}.log"
					 filePattern="${logDir}/$${date:yyyy-MM}/${logFile}.%d{yyyy-MM-dd}-%i.log.gz">

			<!--日志输出格式-->
			<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %t %5p [%c:%L] - %m%n" />

			<!--满足任何一个policy即进行归档-->
			<Policies>
				<!--当前日志与开始日期不匹配（RollingFile中配置的filePattern中配置的最小时间单位不匹配时）时进行归档-->
				<TimeBasedTriggeringPolicy/>
				<!--文件超过5M进行归档-->
				<SizeBasedTriggeringPolicy size="5 MB" />
			</Policies>

			<!--归档的文件最大数量-->
			<DefaultRolloverStrategy max="10">
				<!--删除规则-->
				<Delete basePath="${logDir}" maxDepth="2">
					<!--匹配文件规则-->
					<IfFileName glob="*.log.gz">
						<IfLastModified age="7d">
							<IfAny>
								<!--logDir下文件总大小超过50M，进行删除-->
								<IfAccumulatedFileSize exceeds="50 MB" />
								<!--logDir下文件总数量超过10，进行删除-->
								<IfAccumulatedFileCount exceeds="10" />
							</IfAny>
						</IfLastModified>
					</IfFileName>
				</Delete>
			</DefaultRolloverStrategy>
		</RollingFile>
	</Appenders>

	<Loggers>
		<Root level="debug">
			<AppenderRef ref="STDOUT" />
			<AppenderRef ref="RollingFile" />
		</Root>
	</Loggers>
</Configuration>

4.总结

log4j 2.x相对于1.x增加了大量的api及高级特性，由于目前很少用到其他appender组件，本文仅仅列了下所有的appender组件的作用，只介绍了几个常用的appender组件，后面用到其他组件在总结吧。