java - 如何以编程方式禁用 BurstFilter 并使用 log4j2 中的某些参数启用它？

Question

我打算使用 log4j2 的 burstFilter在我的突发日志管理应用程序中。我们的想法是禁用它，直到管理员真正想要使用它为止(我计划在应用程序 GUI 中提供一个选项，以从用户那里获取参数并相应地激活 burstFilter)。

我研究了它的文档并意识到这只是 log4j2.xml 文件中的配置更改。无论如何，这个 xml 配置将与应用程序捆绑在一起，我将包含这样的过滤器..

<Console name="console">
 <PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %x %t %m%n"/>
 <filters>
  <Burst level="INFO" rate="16" maxBurst="100"/>
 </filters>
</Console>

现在，这里 rate和maxBurst字段设置为某些值，这不是我默认的期望值。我想到的一种解决方案就是不使用 <filters>默认情况下标记，并在用户在 GUI 中设置这些参数后显式写入 log4j2.xml，如下所示。

<Burst level="INFO" rate="16" maxBurst="100"/>

这感觉像是最新奇的解决方案，所以我想知道是否有任何默认属性可以切换以打开或关闭过滤器。

期望:默认log4j2.xml:

 <filters>
  <Burst Activated="False" rate="16" maxBurst="100"/>
 </filters>

如果用户想要激活它:

 <filters>
  <Burst Activated="True" rate="16" maxBurst="100"/>
 </filters>

如有任何帮助，我们将不胜感激。谢谢

Answer 1

除非过滤器提供一个参数来启用/禁用它，否则我不知道有什么方法可以直接切换它。但是，如果您使用RoutingAppender，则可以实现切换。从带有过滤器的附加器切换到不带过滤器的附加器。显然，缺点是您需要配置 2 个附加程序，这可能会导致配置数据出现一些重复。 (您可以将一些内容提取到两者之间共享的公共(public)属性中)

这是一个使用 ThresholdFilter 的简单示例，演示了上述策略:

一、log4j2.xml配置文件:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <!-- 
        See how I defined a common property to hold the pattern since it is used
        in both appenders below.
     -->
    <Properties>
        <Property name="pattern">%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Property>
      </Properties>
    <Appenders>
        <Console name="ConsoleWithFilter" target="SYSTEM_OUT">
            <PatternLayout pattern="${pattern}" />
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
        </Console>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${pattern}" />
        </Console>
        <Routing name="Routing">
            <Routes pattern="$${ctx:filterToggle}">
                <!-- This route is chosen if ThreadContext has value "ENABLE" for key filterToggle. -->
                <Route key="ENABLE" ref="ConsoleWithFilter" />
                <!-- This is the default route when no others match -->
                <Route ref = "Console"/>                
            </Routes>
        </Routing>
    </Appenders>

    <Loggers>
        <Root level="ALL">
            <AppenderRef ref="Routing" />
        </Root>
    </Loggers>
</Configuration>

接下来是一些生成日志的 Java 代码:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;

public class SomeClass {

    private static final Logger log = LogManager.getLogger();

    public static void main(String[] args){
        //We start with no value in the ThreadContext for filterToggle
        //  this should cause all logs to appear in the console.

        if(log.isDebugEnabled())
            log.debug("This is some debug! (This should appear in console)");
        log.info("Here's some info! (This should appear in console)");
        log.error("Some error happened! (We will also see this in the console)");

        //Now we enable the filter by switching appenders
        ThreadContext.put("filterToggle", "ENABLE");

        log.info("This should not appear in the console");
        log.debug("This also should --not-- appear");
        log.fatal("This will appear since it's more specific than ERROR level.");
    }
}

最后，这是上面的输出:

12:22:35.922 [main] DEBUG example.SomeClass - This is some debug! (This should appear in console)
12:22:35.923 [main] INFO  example.SomeClass - Here's some info! (This should appear in console)
12:22:35.923 [main] ERROR example.SomeClass - Some error happened! (We will also see this in the console)
12:22:35.924 [main] FATAL example.SomeClass - This will appear since it's more specific than ERROR level.

希望这对您有帮助!