Log4J2 - assigning file appender filename at runtime

Question

I have a log4j2.xml config file in the class path. One of the appenders is a File appender, and I would like to set the target file name at run time in the Java application.

According to the docs I should be able to use a double "$" and a context prefix in the log4j2.xml file:

<appenders>
    <File name="MyFile" fileName="$${sys:logFilename}">
        <PatternLayout pattern="%-4r %d{${datestamp}} [%t] %-5level %logger{36} - %msg%n"/>
    </File>
</appenders>

where the "sys" prefix indicates that the Configurator will lookup the property "logFilename" in the system properties. So in the application, I call (rather early on):

System.setProperty("logFilename", filename);

I have also turned on auto-reconfiguration for log4j2 in the xml file:

<configuration status="debug" monitorInterval="5">>

Unfortunately, this has no effect whatsoever, and the log file is never created. Some of the log4j2 status output is below:

2013-02-13 15:36:37,574 DEBUG Calling createAppender on class org.apache.logging.log4j.core.appender.FileAppender for element File with params(fileName="${sys:logFilename}", append="null", locking="null", name="MyFile", immediateFlush="null", suppressExceptions="null", bufferedIO="null", PatternLayout(%-4r %d{yyyy-MM-dd/HH:mm:ss.SSS/zzz} [%t] %-5level %logger{36} - %msg%n), null)

2013-02-13 15:36:37,576 DEBUG Starting FileManager ${sys:logFilename}

How can I have the value of "fileName" in the File Appender be set at run time? Alternatively, how can I simply add a new File Appender to the root logger at run time? In Log4j 2.0 most of the API to change the configuration is hidden.

Answer 1

h/t rgoers The FileAppender doesn't support two dollar signs on the file name as the file is opened when the appender is started. What you are indicating with two dollar signs is that you want - potentially - a different file name for each event.

With a single $ (as in ${sys:logFilename}), the system will look for property "logFilename" in the system properties.

Thus, the log4j2.xml should have:

<appenders>
    <File name="MyFile" fileName="${sys:logFilename}">
        <PatternLayout pattern="%-4r %d{${datestamp}} [%t] %-5level %logger{36} - %msg%n"/>
    </File>
</appenders>

The Java application should set the system property:

System.setProperty("logFilename", filename);

and reconfigure the logger:

org.apache.logging.log4j.core.LoggerContext ctx =
    (org.apache.logging.log4j.core.LoggerContext) LogManager.getContext(false);
ctx.reconfigure();

This produces the desired behavior.

Answer 2

As of log4j2 version 2.5 here is the simplest way to achieve this:

In your log4j2.xml:

<Appenders>
   <File name="MyFile" filename="${sys:logFilename}">
   ...

In you main MyApp.java file:

public class MyApp {

    Logger log;

    static {
          System.setProperty("logFilename", ...);
          log = LogManager.getLogger();
    }

    public static void main(String... args) {...}
}

CATCH: You should set logFilename system property before log4j2 is loaded. In this example before calling LogManager.getLogger.

Answer 3

I know this topic is old, but the answers did not really suit me. Here is a function which allows you to reconfigure an existing Appender at runtime:

static void updateLogger(String file_name, String appender_name, String package_name){
LoggerContext context = (LoggerContext) LogManager.getContext(false);
    Configuration configuration = context.getConfiguration();
    Layout<? extends Serializable> old_layout = configuration.getAppender(appender_name).getLayout();

    //delete old appender/logger
    configuration.getAppender(appender_name).stop();
    configuration.removeLogger(package_name);

    //create new appender/logger
    LoggerConfig loggerConfig = new LoggerConfig(package_name, Level.INFO, false);
    FileAppender appender = FileAppender.createAppender(file_name, "false", "false", appender_name, "true", "true", "true",
            "8192", old_layout, null, "false", "", configuration);
    appender.start();
    loggerConfig.addAppender(appender, Level.INFO, null);
    configuration.addLogger(package_name, loggerConfig);

    context.updateLoggers();
}

You can specify a file name, the name of your appender and the package name which you want to log.

Example Logger:

<File name="fileWriter_api" fileName="${LOG_DIR}/api.log" append="false">
  <PatternLayout pattern="${PATTERN}"/>
</File>

Can be reconfigured calling like this:

updateLogger("log/api_new.log", "fileWriter_api", "my.package");

Answer 4

What you can do is, when running the application, pass logFilename as an argument to the JVM:

java -DlogFilename=myAppName.log -jar /path/to/myApp.jar