AI专业者开发社区 1 号成员
  •  0 回帖  •  3 浏览  •  4 个月前
 

5-log4j2.xml配置文件各个节点详解

 

具体配置参考官网：http://logging.apache.org/log4j/2.x/manual/configuration.html

 

一、log.xml 文件的大致结构

 

<?xml version="1.0" encoding="UTF-8"?>;
<Configuration>
  <Properties>
    <Property name="name1">value</property>
    <Property name="name2" value="value2"/>
  </Properties>
  <filter  ... />
  <Appenders>
    <appender ... >
      <filter  ... />
    </appender>
    ...
  </Appenders>
  <Loggers>
    <Logger name="name1">
      <filter  ... />
    </Logger>
    ...
    <Root level="level">
      <AppenderRef ref="name"/>
    </Root>
  </Loggers>
</Configuration>

 

二、各个节点解释

Configuration： 根节点
 
属性包含：
    status ：有效值包含“trace”、“debug”、“info”、“warn”、“error” 和“fatal”，用于控制日志框架本身的日志级别
    monitorInterval： 含义是每隔多少秒重新读取配置文件，可以在不重启应用的情况下修改配置文件
 
Appenders： 输出源，用于定义日志输出的节点
 
    目前支持的输出源包括控制台 Console、文件 File、按照日期切割文件 RollingRandomAccessFile、mongoDB、Flume、Kafka 等

  • 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🇲🇲ss.SSS} [%t] %-5level %logger{36} - %msg%n”

 

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

其他常用的占位符有：
%F 输出所在的类文件名，如 Log4j2Test.java
%L 输出行号
%M 或 %method 输出所在方法名
%l 输出完整的错误位置, 包括类名、方法名、文件名、行数
%p 该条日志的优先级
%replace{pattern}{regex}{substitution} 将 pattern 的输出结果 pattern 按照正则表达式 regex 替换成 substitution

 

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。
 
properties：属性 
 
使用来定义常量，以便在其他配置的时候引用，该配置是可选的
 
Filters： 组合过滤器

 

 

<Filters>  
    <ThresholdFilter level="TRACE" onMatch="NEUTRAL" onMismatch="DENY"/>  
    <RegexFilter regex=".* test .*" onMatch="NEUTRAL" onMismatch="DENY"/>  
           <TimeFilter start="05:00:00" end="05:30:00" onMatch="NEUTRAL" onMismatch="DENY"/>          
</Filters>

 

 

<Filters> 是组合过滤器额标签，子节点包含ThresholdFilter - 日志等级过滤器，RegexFilter 正则表达式过滤器和TimeFilter - 时间过滤器。

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