如何根据 java 系统属性有条件地添加 log4j2 appender?

mac*_*mac 6 java log4j log4j2

我试图弄清楚如何根据是否提供/设置 java 系统属性将 appender 添加到记录器。

所以假设我有一个这样的基本配置:

<Logger name="myLogger" level="info" additivity="false">
  <AppenderRef ref="myAppender1" />
  <AppenderRef ref="myAppender2" />
</Logger>
Run Code Online (Sandbox Code Playgroud)

所以现在我想找出一种方法,如果我提供参数 -PaddAppender2,则有条件地只添加第二个 appender。像这样的东西:

<Logger name="myLogger" level="info" additivity="false">
  <AppenderRef ref="myAppender1" />
  <?if (${sys:enableAppender2:-false) == "true"}>
  <AppenderRef ref="myAppender2" />
  </?if> 
</Logger>
Run Code Online (Sandbox Code Playgroud)

我怎么做?

我知道我可以例如在给定的属性(“logLevel”)上使级别动态(如果未给出属性,则“信息”是默认值):

<Logger name="test" level="${sys:logLevel:-info}" additivity="false">
Run Code Online (Sandbox Code Playgroud)

我查看了过滤器文档,但我无法弄清楚。这当然是如果过滤器是正确的方法。

sap*_*ens 8

没有任何脚本的解决方案:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="error" strict="true">
    <Properties>
        <Property name="appenderToUse">stdout_${sys:LOG4J_LAYOUT:-plain}</Property>
    </Properties>

    <Appenders>
        <Appender type="Console" name="stdout_plain">
            <Layout type="PatternLayout" pattern="%d [%t] %-5p %c - %m%n"/>
        </Appender>

        <Appender type="Console" name="stdout_json">
            <Layout type="JSONLayout" compact="true" eventEol="true" stacktraceAsString="true" properties="true"/>
        </Appender>
    </Appenders>

    <Loggers>
        <Root level="info">
            <AppenderRef ref="${appenderToUse}"/>
        </Root>
    </Loggers>
</Configuration>
Run Code Online (Sandbox Code Playgroud)

  • 与“NullAppender”结合使用,这个解决方案让我很高兴 - 现在我可以在需要时打开/关闭“Console”附加器! (3认同)
  • 甚至可以内联工作,无需显式的 `&lt;Property&gt;` 声明 (2认同)

Lam*_*bda 5

Robert 提供的解决方案有效,但效率不高,因为每个日志记录都会对脚本进行一次评估。

仅评估脚本一次的更有效的解决方案是ScriptAppenderSelector与以下一起使用NullAppender

根据文档:

ScriptAppender选择器

构建配置后,ScriptAppenderSelector 附加程序会调用脚本来计算附加程序名称。然后,Log4j 使用 ScriptAppenderSelector 的名称创建 AppenderSet 下列出的指定附加程序之一。配置后,Log4j 会忽略 ScriptAppenderSelector。

空追加器

忽略日志事件的 Appender。用于与版本 1.2 兼容并方便地编写 ScriptAppenderSelector

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="ScriptAppenderSelectorExample">
    <Appenders>
        <ScriptAppenderSelector name="SelectConsole">
            <Script language="groovy"><![CDATA[
                if (System.getProperty("CONSOLE_APPENDER_ENABLED", 'true').equalsIgnoreCase('true')) {
                    return "Console"
                } else {
                    return "Null"
                }
            ]]></Script>
            <AppenderSet>
                <Console name="Console" target="SYSTEM_OUT">
                    <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
                </Console>
                <Null name="Null" />
            </AppenderSet>
        </ScriptAppenderSelector>

        <ScriptAppenderSelector name="SelectFile">
            <Script language="groovy"><![CDATA[
                if (System.getProperty("FILE_APPENDER_ENABLED", 'true').equalsIgnoreCase('true')) {
                    return "File"
                } else {
                    return "Null"
                }
            ]]></Script>
            <AppenderSet>
                <File name="File" fileName="application.log">
                    <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
                </File>
                <Null name="Null" />
            </AppenderSet>
        </ScriptAppenderSelector>

        <ScriptAppenderSelector name="SelectSMTP">
            <Script language="groovy"><![CDATA[
                if (System.getProperty("SMTP_APPENDER_ENABLED", 'true').equalsIgnoreCase('true')) {
                    return "SMTP"
                } else {
                    return "Null"
                }
            ]]></Script>
            <AppenderSet>
                <SMTP name="SMTP"
                      subject="App: Error"
                      from="log4j@example.com"
                      to="support@example.com"
                      smtpHost="smtp.example.com"
                      smtpPort="25"
                      bufferSize="5">
                </SMTP>
                <Null name="Null" />
            </AppenderSet>
        </ScriptAppenderSelector>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="SelectConsole"/>
            <AppenderRef ref="SelectFile"/>
            <AppenderRef ref="SelectSMTP"/>
        </Root>
    </Loggers>
</Configuration>
Run Code Online (Sandbox Code Playgroud)

参考


mac*_*mac 0

我无法仅通过配置文件找出解决方案,但我找到了一个可以以编程方式解决问题的解决方案。

请注意,在我们的特定情况下,我们总是记录到“本地日志”(“splunk local”),但在给定情况下(由属性控制),我们还希望将相同的信息记录到另一个位置(不是相对的) )并定期读取并转发到 splunk 服务器(“splunk 转发器”)。

这就是为什么我们可以将大部分属性从一个记录器复制到另一个记录器。

private static final Logger SPLUNK_LOG = getLogger();

private static Logger getLogger() {
    if (!BooleanUtils.toBoolean(SystemUtils.getJavaPropertyValue(ENABLE_PROPERTY_NAME, "false"))) {
        return LoggerFactory.getLogger(SPLUNK_LOG_NAME);
    } else {
        LOG.info("Dynamically adding splunk forwarder appender");
        try {
            final LoggerContext loggerContext = (LoggerContext) LogManager.getContext();
            final Configuration configuration = loggerContext.getConfiguration();

            // configure appender based on local splunk appender
            final RollingFileAppender splunkLocal = (RollingFileAppender) configuration.getAppender(LOCAL_LOG_NAME);
            final RollingFileAppender splunkForwarder = RollingFileAppender.createAppender(FORWARDER_FILE_NAME,
                    FORWARDER_FILE_PATTERN, FORWARDER_APPEND, FORWARDER_NAME, null, null, null,
                    splunkLocal.getManager().getTriggeringPolicy(), splunkLocal.getManager().getRolloverStrategy(),
                    splunkLocal.getLayout(), splunkLocal.getFilter(), null, FORWARDER_ADVERTISE, null, null);
            splunkForwarder.start();

            // add splunk forwarder appender to splunk logger
            final LoggerConfig loggerConfig = configuration.getLoggerConfig(SPLUNK_LOG_NAME);
            loggerConfig.addAppender(splunkForwarder, Level.INFO, null);

            LOG.info("Successfully added splunk forwarder appender");
            return loggerContext.getLogger(SPLUNK_LOG_NAME);
        } catch (Exception ex) {
            throw new IllegalStateException("Failed to dynamically add splunk forwarder appender", ex);
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

如果有人知道如何仅通过配置文件来做到这一点,那就太好了。