log4j2配置详解

最新推荐文章于 2024-09-09 10:11:35 发布

weixin_52189442

最新推荐文章于 2024-09-09 10:11:35 发布

阅读量1k

点赞数

分类专栏： log4j2 大数据文章标签： log4j2

本文链接：https://blog.csdn.net/weixin_52189442/article/details/119918220

版权

大数据同时被 2 个专栏收录

27 篇文章 2 订阅

订阅专栏

log4j2

1 篇文章 0 订阅

订阅专栏

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

log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式，2.x版本配置文件后缀名只能为".xml",".json"或者".jsn".

系统选择配置文件的优先级(从先到后)如下：

.classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
.classpath下的名为log4j2-test.xml的文件.
.classpath下名为log4j2.json 或者log4j2.jsn的文件.
.classpath下名为log4j2.xml的文件.
　　我们一般默认使用log4j2.xml进行命名。如果本地要测试，可以把log4j2-test.xml放到classpath，而正式环境使用log4j2.xml，则在打包部署的时候不要打包log4j2-test.xml即可。

.classpath在idea中指的是target下的classes文件夹

二、缺省默认配置文件

<?xml  version = "1.0"  encoding = "UTF-8" ?>
          
<Configuration  status = "WARN" >       
     <Appenders>       
        <Console  name = "Console"  target = "SYSTEM_OUT">         
           <PatternLayout  pattern = "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>           
        </Console>         
     </Appenders>
            
     <Loggers>       
        <Root  level = "error">      
           <AppenderRef  ref = "Console"/>         
        </Root>          
     </Loggers>         
</Configuration>

三、配置详细介绍

1.Configuration根节点

常用属性（其余属性略）：

status：这个用于设置log4j2自身内部的信息输出级别，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出。此属性的有效值为“ trace”，“ debug”，“ info”，“ warn”，“ error”和“ fatal”。
monitorinterval：从文件配置后，Log4j能够自动检测对配置文件的更改并自行重新配置。用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s。

Configuration有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger)

2.Appenders节点

输出源，用于定义日志输出的地方、日志打印内容、格式、方式、保存策略等。
可以使用特定的appender标签名称或者标签+type属性来配置appender，都必须有name属性，且该name值唯一，该name将在标签中被使用。
log4j2支持的输出源有很多，有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume 等

（1）Console子节点

Console节点用来定义输出到控制台的Appender

属性：

name：指定Appender的名字.
target：SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

子节点：

PatternLayout：pattern属性设置输出格式，不设置默认为:%m%n.

（2）File子节点

File节点用来定义输出到指定位置的文件的Appender

属性：

name：指定Appender的名字.
fileName：指定输出日志的目的文件带全路径的文件名.

子节点：

PatternLayout：pattern属性设置输出格式，不设置默认为:%m%n.

（3）RollingFile子节点

RollingFile节点用来定义超过指定大小自动创建新文件的Appender

属性：

name:指定Appender的名字.
fileName:指定输出日志的目的文件带全路径的文件名.
filePattern:指定新建日志文件的名称格式.

子节点：

PatternLayout:输出格式，不设置默认为:%m%n.
Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am…而不是7am.
SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件

（4）Async子节点

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

（5）其他非常用输出源

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

（6）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 输出语句所在的行数, 包括类名、方法名、文件名、行数

3.Loggers节点

日志器，只有此处配置了Appender，Appender才会生效。
日志器分根日志器Root和自定义日志器，当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器，自定义时需要指定每个Logger的名称name（对于命名可以以包名作为日志的名字，不同的包配置不同的级别等），日志级别level，相加性additivity（是否同时输出log到父类的appender）。
常见的有两种子节点:Root（根日志器）和Logger（自定义日志器）.

（1）Root子节点

Root节点用来配置项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出。每个log4j2的配置都必须有，但可缺省，使用默认的root具有error级别，并且仅附加Console控制台打印

属性：

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

子节点：

AppenderRef：Root的子节点，ref属性用来指定该日志输出到哪个Appender，可以定义多个。

（2）Logger子节点

Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别、日志输出形式等。
log4j2允许日志打印到一个或多个目标文件，该标签可以配置一个或多个AppenderRef子元素，ref属性值设置为某个Appender的name，与该Appender关联，每一个Appender为一个日志输出目标。

属性：

level：日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点
additivity：是否同时在父Logger的appender输出，默认为true，设为false后，只在自定义的Appender中进行输出。

子节点：

AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。可以定义多个。

4.Properties子节点

Log4j2支持在配置中定义全局属性。在Properties节点中定义property子节点及其属性即可定义全局变量。

子节点：

property：name属性必须存在且唯一，允许使用${name}来引用该变量。

有两种写法：

 <Properties>
   <property name="APP_NAME" value="athena-cif"/>
 </Properties>

 <Properties>
   <property name="APP_NAME">athena-cif</property>
 </Properties>

5.配置过滤器< Filters >

6.AsyncLogger

7.关于日志level

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

All:最低等级的，用于打开所有日志记录.
Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
Info:消息在粗粒度级别上突出强调应用程序的运行过程.
Warn:输出警告及warn以下级别的日志.
Error:输出错误信息日志.
Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
OFF:最高等级的，用于关闭所有日志记录。

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

四、配置pom.xml,引入log4j2必要的依赖(log4j-api、log4j-core)

<properties>
  	<junit.version>3.8.1</junit.version>
  	<log4j.version>2.5</log4j.version>
</properties>

<!-- 使用aliyun镜像 -->
<repositories>
  <repository>
      <id>aliyun</id>
      <name>aliyun</name>
      <url>http://maven.aliyun.com/nexus/content/groups/public</url>
  </repository>
</repositories>

<dependencies>
	<dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-api</artifactId>  
        <version>${log4j.version}</version>  
    </dependency>  
    <dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-core</artifactId>  
        <version>${log4j.version}</version>  
    </dependency>  
</dependencies>

五、比较完整的log4j2.xml配置模板

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
  <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

  <!--变量配置-->
  <Properties>
    <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
    <!-- %logger{36} 表示 Logger 名字最长36个字符 -->
    <property name="LOG_PATTERN"
      value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%X{transId}] [%X{requestGlobalJnlNo},%X{requestChannelCode}] [%X{requestUserSeq},%X{bankId}] %logger{36} %msg%n"/>
    <!-- 定义日志存储的路径 -->
    <property name="APP_NAME" value="athena-cif"/>
    <property name="FILE_PATH" value="./../logs/athena-cif"/>
    <property name="ROLLOVER_STRATEGY_AGE" value="30d"/>
    <property name="ROLLOVER_STRATEGY" value="30"/>
    <!-- 控制台默认输出格式,"%-5level":日志级别,"%l":输出完整的错误位置,是小写的L,因为有行号显示,所以影响日志输出的性能 -->
    <property name="console_log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %l - %m%n</property>
    <!-- 日志文件默认输出格式,不带行号输出(行号显示会影响日志输出性能);%C:大写,类名;%M:方法名;%m:错误信息;%n:换行 -->
    <!-- <property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %C.%M - %m%n</property> -->
    <!-- 日志文件默认输出格式,另类带行号输出(对日志输出性能未知);%C:大写,类名;%M:方法名;%L:行号;%m:错误信息;%n:换行 -->
    <property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %C.%M[%L line] - %m%n
    </property>

    <!-- 日志默认切割的最小单位 -->
    <property name="EVERY_FILE_SIZE">100MB</property>
    <!-- 日志默认输出级别 -->
    <property name="OUTPUT_LOG_LEVEL">INFO</property>
  </Properties>

  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <!--输出日志的格式-->
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
      <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
    </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="SysDefaultFile" fileName="${FILE_PATH}/${APP_NAME}-system-default.log"
      filePattern="${FILE_PATH}/history/$${date:yyyy-MM-dd}/${APP_NAME}-system-default-%d{yyyy-MM-dd}_%i.log.gz">
      <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
      <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <Policies>
        <!--interval属性用来指定多久滚动一次，默认是1 hour，
	        	如果filePattern 是%d{yyyy-MM-dd}，则 interval="1"表示1天，
	        	如果是%d{yyyy-MM-dd-HH-mm}，则 interval="1"表示1分钟，
	        	如果设置 size="10MB" ，则一个interval单位内，日志超过10m，则也会滚动压缩-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="${EVERY_FILE_SIZE}"/>
        <OnStartupTriggeringPolicy />
      </Policies>
      <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件-->
      <DefaultRolloverStrategy max="${ROLLOVER_STRATEGY}">
        <!--
             basePath：从哪里扫描要删除的文件的基本路径
             maxDepth: 要访问的目录的最大级别数。值为0表示仅访问起始文件（基本路径本身），除非被安全管理者拒绝。
             Integer.MAX_VALUE的值表示应该访问所有级别。默认为1，意思是指定基本目录中的文件。
        -->
        <Delete basePath="${FILE_PATH}/history/" maxDepth="2">
          <IfFileName glob="*/*.gz"/>
          <!--!Note: 这里的age必须和filePattern协调, 后者是精确到HH, 这里就要写成xH, xd就不起作用
          另外, 数字最好>2, 否则可能造成删除的时候, 最近的文件还处于被占用状态,导致删除不成功!-->
          <!--7天-->
          <IfLastModified age="${ROLLOVER_STRATEGY_AGE}"/>
        </Delete>
      </DefaultRolloverStrategy>

    </RollingFile>
    <RollingFile name="SysNacosFile"
      fileName="${FILE_PATH}/${APP_NAME}-system-nacos.log"
      filePattern="${FILE_PATH}/history/$${date:yyyy-MM-dd}/${APP_NAME}-system-nacos-%d{yyyy-MM-dd}_%i.log.gz">
      <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
      <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <Policies>
        <!--interval属性用来指定多久滚动一次，默认是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="${EVERY_FILE_SIZE}"/>
        <OnStartupTriggeringPolicy />
      </Policies>
      <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件-->
      <DefaultRolloverStrategy max="${ROLLOVER_STRATEGY}">
        <Delete basePath="${FILE_PATH}/history/" maxDepth="2">
          <IfFileName glob="*/*.gz"/>
          <!--!Note: 这里的age必须和filePattern协调, 后者是精确到HH, 这里就要写成xH, xd就不起作用
          另外, 数字最好>2, 否则可能造成删除的时候, 最近的文件还处于被占用状态,导致删除不成功!-->
          <!--7天-->
          <IfLastModified age="${ROLLOVER_STRATEGY_AGE}"/>
        </Delete>
      </DefaultRolloverStrategy>
    </RollingFile>
    <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
    <RollingFile name="BizDomainFile"
      fileName="${FILE_PATH}/${APP_NAME}-biz-domain.log"
      filePattern="${FILE_PATH}/history/$${date:yyyy-MM-dd}/${APP_NAME}-biz-domain_%d{yyyy-MM-dd}_%i.log.gz">
      <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
      <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="${LOG_PATTERN}"/>
      <Policies>
        <!--interval属性用来指定多久滚动一次，默认是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="${EVERY_FILE_SIZE}"/>
        <OnStartupTriggeringPolicy />
      </Policies>
      <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件-->
      <DefaultRolloverStrategy max="${ROLLOVER_STRATEGY}">
        <Delete basePath="${FILE_PATH}/history" maxDepth="2">
          <IfFileName glob="*/*.gz"/>
          <!--!Note: 这里的age必须和filePattern协调, 后者是精确到HH, 这里就要写成xH, xd就不起作用
          另外, 数字最好>2, 否则可能造成删除的时候, 最近的文件还处于被占用状态,导致删除不成功!-->
          <!--7天-->
          <IfLastModified age="${ROLLOVER_STRATEGY_AGE}"/>
        </Delete>
      </DefaultRolloverStrategy>

    </RollingFile>


  </appenders>

  <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
  <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
  <loggers>
    <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <Logger name="org.springframework" level="info" additivity="false">
      <AppenderRef ref="Console"/>
      <AppenderRef ref="SysDefaultFile"/>
    </Logger>
    <AsyncLogger name="springfox.documentation" level="error" additivity="false">
      <AppenderRef ref="Console"/>
      <AppenderRef ref="SysDefaultFile"/>
    </AsyncLogger>
    <AsyncLogger name="com.alibaba.nacos" level="warn" additivity="false">
      <AppenderRef ref="Console"/>
      <AppenderRef ref="SysNacosFile"/>
    </AsyncLogger>
    <AsyncLogger name="org.mybatis" level="error" additivity="false">
      <AppenderRef ref="Console"/>
      <AppenderRef ref="SysDefaultFile"/>
    </AsyncLogger>
    <AsyncLogger name="com.csii.athena" level="debug" additivity="false">
      <AppenderRef ref="Console"/>
      <AppenderRef ref="BizDomainFile"/>
    </AsyncLogger>
    <root level="info">
      <appender-ref ref="SysDefaultFile"/>
    </root>
  </loggers>

</configuration>