Log4j2的Configuration详解

清疚 2024-03-24 13:27 81阅读 0赞

## 引言 ##

> 官方配置文档：[https://logging.apache.org/log4j/2.x/manual/filters.html][https_logging.apache.org_log4j_2.x_manual_filters.html]

--------------------

## `<Configuration>`节点 ##

### Parameters ###

<table> 
 <thead> 
  <tr> 
   <th align="left">Attribute Name</th> 
   <th align="left">Description</th> 
   <th align="left"></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">advertiser</td> 
   <td align="left">(Optional) The Advertiser plugin name which will be used to advertise individual FileAppender or SocketAppender configurations. The only Advertiser plugin provided is 'multicastdns".</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">dest</td> 
   <td align="left">Either “err” for stderr, “out” for stdout, a file path, or a URL.</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>monitorInterval</code></td> 
   <td align="left">设置配置文件的<code>动态加载</code>时间的，单位是秒<br>The minimum amount of time, in seconds, that must elapse before the file configuration is checked for changes.<br>Log4j has the ability to <code>automatically</code> <code>detect changes</code> to the configuration file and <code>reconfigure itself</code>.for example, <code>&lt;Configuration monitorInterval="30"&gt;</code> mean the configuration file will be checked for changes only after at least <code>30 seconds</code> have elapsed. The <code>minimum</code> interval is 5 seconds.</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>name</code></td> 
   <td align="left">The <code>name</code> of the configuration.</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">packages</td> 
   <td align="left"><strong>Use of the packages attribute is deprecated and will be removed in Log4j 3.0.</strong> Plugins should be processed with the Log4j annotation processor. A comma separated list of package names to search for plugins. Plugins are only loaded once per classloader so changing this value may not have any effect upon reconfiguration.</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">schema</td> 
   <td align="left">Identifies the location for the classloader to located the XML Schema to use to validate the configuration. Only valid when strict is set to true. If not set no schema validation will take place.</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">shutdownHook</td> 
   <td align="left">Specifies whether or not Log4j should automatically shutdown when the JVM shuts down. The shutdown hook is enabled by default but may be disabled by setting this attribute to “disable”</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">shutdownTimeout</td> 
   <td align="left">Specifies how many milliseconds appenders and background tasks will get to shutdown when the JVM shuts down. Default is zero which mean that each appender uses its default timeout, and don’t wait for background tasks. Not all appenders will honor this, it is a hint and not an absolute guarantee that the shutdown procedure will not take longer. Setting this too low increase the risk of losing outstanding log events not yet written to the final destination. See <a href="https://logging.apache.org/log4j/2.x/log4j-core/target/site/apidocs/org/apache/logging/log4j/core/LoggerContext.html#stoplong_java.util.concurrent.TimeUnit" rel="nofollow">LoggerContext.stop(long, java.util.concurrent.TimeUnit)</a>. (Not used if <code>shutdownHook</code> is set to “disable”.)</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>status</code></td> 
   <td align="left">指定log4j本身的打印日志的级别<br>The level of <code>internal Log4j events</code> that should <code>be logged to the console</code>. Valid values for this attribute are “off”, “trace”, “debug”, “info”, “warn”, “error”, “fatal”, and “all”. Log4j will <code>log details about initialization, rollover and other internal actions</code> to the status logger. Setting <code>status="trace"</code> is one of the first tools available to you if you need to <code>troubleshoot log4j</code>.(Alternatively, setting <code>system property</code> <code>log4j2.debug</code> will also <code>print internal Log4j2 logging</code> to the <code>console</code>, including <code>internal logging</code> that took place <code>before the configuration file was found</code>.)</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">strict</td> 
   <td align="left">Enables the use of the strict XML format. Not supported in JSON configurations.</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">verbose</td> 
   <td align="left">Enables diagnostic information while loading plugins.</td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>

--------------------

### 场景1： ###

<Configuration status="info" monitorInterval="10">
    </Configuration>

[https_logging.apache.org_log4j_2.x_manual_filters.html]: https://logging.apache.org/log4j/2.x/manual/filters.html