Configuring log4j2

To use log4j2, ensure that the log4j2 JAR is at /slf4j2-binding.jar. log4j2 is already located here when you first install the Diffusion server. Use the log4j2.xml configuration file to configure the behavior of log4j2.

If you are upgrading from a version before 6.4, to use log4j2 instead of the legacy Diffusion logging implementation, copy lib/thirdparty/log4j-slf4j2-impl-*.jar to lib/slf4j2-binding.jar. This file controls the log4j2 logging. Settings in etc/Logs.xml that configured the legacy Diffusion logging implementation are no longer supported and must be removed.

When the Diffusion™ server is configured to use the log4j2 logging framework, the Diffusion server it uses the log4j2.xml configuration file.

The log4j2.xml configuration file is located in the etc directory of your Diffusion installation. For more information about how to use this file to configure log4j2, see the log4j2 documentation: http://logging.apache.org/log4j/2.x/manual/configuration.html

By default, the provided log4j2.xml file is configured to output log messages in the format described at Logging reference. In your configuration file, you can create a property that defines the format to output log messages in:

<Property name="pattern">
	%date{DEFAULT_PERIOD}|%level|%thread|%marker|%notEmpty{&lt;%X{principal}&gt;}|%X{session}|%replace{%msg}{\|}{¦}|%logger%n%xEx
</Property>

You can use this property to specify the format used by your appenders. The property %marker indicates the message code. For more information, see Logging reference.

By default, the provided log4j2.xml file is configured to append log output to the console and to a file. This is the same behavior as the legacy logging framework.

<Loggers>
        <AsyncRoot level="info" includeLocation="false">
            <AppenderRef ref="console" />
            <AppenderRef ref="file" />
        </AsyncRoot>
    </Loggers>

You can configure other appenders to output to the log messages to different destinations. For more information about using appenders, see https://logging.apache.org/log4j/2.x/manual/appenders.html.