如何以编程方式正确配置log4j2？

Question

我正在尝试使用RollingFileAppender设置log4j2以写入日志。我希望以编程方式配置日志记录系统，而不是使用XML文件。

以下是我尝试过的内容（大部分与网站上的文档相同）https://logging.apache.org/log4j/2.x/manual/customconfig.html#Configurator):

public static void configure(String rootLevel, String packageLevel) {
    ConfigurationBuilder<BuiltConfiguration> builder = ConfigurationBuilderFactory
        .newConfigurationBuilder();

    builder.setConfigurationName("RollingBuilder");
    builder.setStatusLevel(Level.TRACE);

    // Create a rolling file appender

    LayoutComponentBuilder layoutBuilder = builder.newLayout("PatternLayout")
        .addAttribute("pattern", "%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p %c{1}:%L - %m%n");

    ComponentBuilder triggeringPolicy =
        builder
            .newComponent("Policies")
            .addComponent(
                builder
                    .newComponent("SizeBasedTriggeringPolicy")
                    .addAttribute("size", "200M")
            );

    AppenderComponentBuilder appenderBuilder =
        builder
            .newAppender("rolling", "RollingFile")
            .addAttribute("fileName", "log")
            .addAttribute("filePattern", "log.%d.gz")
            .add(layoutBuilder)
            .addComponent(triggeringPolicy);

    builder.add(appenderBuilder);

    // Create new logger

    LoggerComponentBuilder myPackageLoggerBuilder =
        builder.newLogger("com.mypackage", packageLevel)
            .add(builder.newAppenderRef("rolling"))
            .addAttribute("additivity", false);
    builder.add(myPackageLoggerBuilder);

    RootLoggerComponentBuilder rootLoggerBuilder =
        builder
            .newRootLogger(rootLevel)
            .add(builder.newAppenderRef("rolling"));
    builder.add(rootLoggerBuilder);

    // Initialize logging
    Configurator.initialize(builder.build());
}

我在main方法的开头调用configure（）方法。当我运行我的程序时，会创建一个名为log的文件，但是所有日志输出都会转到标准输出，并且log文件保持为空。

有人能帮忙找出我的配置有什么问题吗？

我没有使用任何log4j配置文件，如果这有所不同。在我的代码中也使用slf4j API。依赖性-

org.apache.logging.log4j:log4j-api:2.11.1
org.apache.logging.log4j:log4j-core:2.11.1
org.apache.logging.log4j:log4j-slf4j-impl:2.11.1
org.slf4j:slf4j-api:1.7.25

Answer 1

请查找示例根日志，最后需要调用重新配置函数。

java prettyprint-override">RootLoggerComponentBuilder rootLogger = builder
   .newRootLogger(Level.ALL)
   .add(builder.newAppenderRef("LogToRollingFile"));

LoggerComponentBuilder logger = builder
   .newLogger("MyClass",Level.ALL)
   .addAttribute("additivity", false);

Configurator.reconfigure(builder.build());

Answer 2

首先，这个答案是对您评论中提供的附加信息的回应。

我的要求是，我希望在启动程序时通过命令行标志控制不同包的日志级别

由于您希望使用程序参数来控制日志级别，我建议您查看主参数查找和路由附加器。结合使用这两个功能，您可以设置日志记录配置，以便根据程序参数将日志事件发送到相应的附加器。

我将提供一个简单的例子来帮助指导您。

首先，这里是一个生成一些日志事件的示例Java类：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.lookup.MainMapLookup;

public class SomeClass {

    private static Logger log = LogManager.getLogger();

    public static void main(String[] args){
        MainMapLookup.setMainArguments(args);

        if(log.isDebugEnabled())
            log.debug("This is some debug!");
        log.info("Here's some info!");
        log.error("Some error happened!");
    }
}

接下来是log4j2的配置文件（详见代码中的注释）：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Routing name="myRoutingAppender">
            <!-- log events are routed to appenders based on the logLevel program argument -->
            <Routes pattern="$${main:logLevel}">
                <!-- If the logLevel argument is followed by DEBUG this route is used -->
                <Route ref="DebugFile" key="DEBUG" />
                <!-- If the logLevel argument is omitted or followed by any other value this route is used -->
                <Route ref="InfoFile" />
            </Routes>
        </Routing>

        <!-- This appender is not necessary, was used to test the config -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>

        <!-- Below are the 2 appenders used by the Routing Appender from earlier -->
        <File name="DebugFile" fileName="logs/Debug.log" immediateFlush="true"
            append="false">
            <PatternLayout
                pattern="%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </File>

        <File name="InfoFile" fileName="logs/Info.log" immediateFlush="true"
            append="false">
            <PatternLayout
                pattern="%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <LevelRangeFilter minLevel="FATAL" maxLevel="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
        </File>
    </Appenders>

    <Loggers>
        <!-- Root logger is set to DEBUG intentionally so that debug events are generated.
             However, events may be ignored by the LevelRangeFilter depending on where they
             are routed by the Routing Appender
         -->
        <Root level="DEBUG">
            <AppenderRef ref="Console" />
            <AppenderRef ref="myRoutingAppender" />
        </Root>
    </Loggers>
</Configuration>

使用此配置如果不提供“logLevel”参数，则默认情况下，日志事件将路由到“InfoFile”附件，并且通过LevelRangeFilter忽略比信息更具体的任何事件。

如果提供了“logLevel”参数并后跟“DEBUG”，则日志事件将路由到“DebugFile”附录器，并且不会忽略任何事件。

请注意，我确实尝试使用查找来设置日志级别，但似乎无法通过查找来配置日志级别参数。这就是为什么我不得不使用这种替代方法。我对这种方法的一个担忧是，正如我在配置文件中的注释中所指出的，日志级别必须保持在DEBUG，这意味着即使您不使用它们，您也总是生成DEBUG事件。这可能会影响性能。一种解决方法是使用程序参数来确定是否需要生成调试事件。例如：

通常你会使用：

if(log.isDebugEnabled())
    log.debug("This is some debug!");

但是当使用上面的配置时，你会使用这样的东西：

if("DEBUG".equals(args[1]))
    log.debug("This is some debug!");

如果需要，您可以使用enum（甚至可以使用log4j2提供的Level类）来提高效率。

我希望这能帮助你开始。