Log4j,禁用依赖于环境的追加器

2022-09-04 08:33:34

我希望有一个log4j.xml配置,并能够在开发应用程序时登录到控制台。部署到环境后,我只想登录到文件追加器,而不是控制台。我怎样才能做到这一点?

这是我当前的配置:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
        <param name="Threshold" value="DEBUG" />
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{dd-MM-yyyy HH:mm:ss} %-5p%c{1} - %m%n" />
        </layout>
    </appender>

    <appender name="LogFileAppender" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="${log-base-dir}/${adapter-name}.log" />
        <param name="MaxFileSize" value="5000KB" />
        <param name="MaxBackupIndex" value="99" />
        <param name="append" value="true" />        
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{dd-MM-yyyy HH:mm:ss} %-5p%c{1} - %m%n" />
        </layout>
    </appender>

    <root>
        <level value="info" />
        <appender-ref ref="ConsoleAppender" />
        <appender-ref ref="LogFileAppender" />
    </root>

</log4j:configuration>

答案 1

其中一个解决方案可能是分离用于开发和生产环境的log4j配置文件,例如:

  • log4j-development.xml- 用于开发环境
  • log4j-production.xml- 用于生产环境

然后,您的应用程序启动命令可以具有指定log4j配置文件的参数,例如java -Dlog4jconfig=log4j-development.xml -jar Application.jar

您可以通过在代码中获取属性值来配置log4j,例如.log4jconfigSystem.getProperty("log4jconfig")

该解决方案的优点如下:

  • 您可以独立指定记录器(在开发中,仅在生产中)ConsoleAppenderLogFileAppenderLogFileAppender
  • 您可以为每个环境指定日志记录级别(例如 在生产和开发中)errordebug
  • 您可以独立配置文件记录器,例如,在生产中保留日志X天(用于审计目的等),并且只有一个日志文件在开发中等。

该模式用于许多应用程序服务器,在这些服务器中,您有多个环境(开发、UAT、过渡、生产等)。

示例log4j-development.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
        <param name="Threshold" value="DEBUG" />
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{dd-MM-yyyy HH:mm:ss} %-5p%c{1} - %m%n" />
        </layout>
    </appender>

    <root>
        <level value="debug" />
        <appender-ref ref="ConsoleAppender" />
    </root>

</log4j:configuration>

示例log4j-production.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <appender name="LogFileAppender" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="${log-base-dir}/${adapter-name}.log" />
        <param name="MaxFileSize" value="5000KB" />
        <param name="MaxBackupIndex" value="99" />
        <param name="append" value="true" />        
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{dd-MM-yyyy HH:mm:ss} %-5p%c{1} - %m%n" />
        </layout>
    </appender>

    <root>
        <level value="error" />
        <appender-ref ref="LogFileAppender" />
    </root>

</log4j:configuration>

答案 2

使用追加器的参数和 JVM 系统属性很容易做到。例如:Threshold

<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
    <param name="Threshold" value="${my.console.level}" />
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d %-5p [%c{1}] %m%n" />
    </layout>
</appender>

然后在生产上使用时启动应用程序-Dmy.console.level=OFF

同时在本地启动使用-Dmy.console.level=ALL

两者都是有效的 log4j 级别。OFFALL


推荐