Class Log4J2LoggingSystem

java.lang.Object

org.springframework.boot.logging.LoggingSystem

org.springframework.boot.logging.AbstractLoggingSystem

org.springframework.boot.logging.log4j2.Log4J2LoggingSystem

public class Log4J2LoggingSystem
extends AbstractLoggingSystem

LoggingSystem for Log4j 2.

Since:

1.2.0

Author:

Daniel Fullarton, Andy Wilkinson, Alexander Heusingfeld, Ben Hale, Ralph Goers, Piotr P. Karwasz, Dhruv Rastogi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Log4J2LoggingSystem.Factory	LoggingSystemFactory that returns Log4J2LoggingSystem if possible.

Nested classes/interfaces inherited from class AbstractLoggingSystem

AbstractLoggingSystem.LogLevels<T>

Field Summary

Fields inherited from class AbstractLoggingSystem

CONFIGURATION_COMPARATOR

Fields inherited from class LoggingSystem

EXPECT_CORRELATION_ID_PROPERTY, NONE, ROOT_LOGGER_NAME, SYSTEM_PROPERTY

Method Summary

Modifier and Type	Method	Description
void	beforeInitialize()	Reset the logging system to be limit output.
void	cleanUp()	Clean up the logging system.
protected String	getDefaultLogCorrelationPattern()	Return the default log correlation pattern or null if log correlation patterns are not supported.
static @Nullable Environment	getEnvironment(@Nullable LoggerContext loggerContext)	Get the Spring Environment attached to the given LoggerContext or null if no environment is available.
@Nullable LoggerConfiguration	getLoggerConfiguration(String loggerName)	Returns the current configuration for a LoggingSystem's logger.
List<LoggerConfiguration>	getLoggerConfigurations()	Returns a collection of the current configuration for all a LoggingSystem's loggers.
protected @Nullable String	getSelfInitializationConfig()	Return any self initialization config that has been applied.
Runnable	getShutdownHandler()	Returns a Runnable that can handle shutdown of this logging system when the JVM exits.
protected @Nullable String	getSpringInitializationConfig()	Return any spring specific initialization config that should be applied.
protected String[]	getStandardConfigLocations()	Return the standard config locations for this system.
Set<LogLevel>	getSupportedLogLevels()	Returns a set of the LogLevels that are actually supported by the logging system.
LoggingSystemProperties	getSystemProperties(ConfigurableEnvironment environment)	Return the LoggingSystemProperties that should be applied.
void	initialize(LoggingInitializationContext initializationContext, @Nullable String configLocation, @Nullable LogFile logFile)	Fully initialize the logging system.
protected void	loadConfiguration(LoggingInitializationContext initializationContext, String location, @Nullable LogFile logFile)	Load a specific configuration.
protected void	loadDefaults(LoggingInitializationContext initializationContext, @Nullable LogFile logFile)	Load sensible defaults for the logging system.
protected void	reinitialize(LoggingInitializationContext initializationContext)	Reinitialize the logging system if required.
void	setLogLevel(@Nullable String loggerName, @Nullable LogLevel logLevel)	Sets the logging level for a given logger.

Methods inherited from class AbstractLoggingSystem

applySystemProperties, getClassLoader, getDefaultValueResolver, getPackagedConfigFile, getSpringConfigLocations

Methods inherited from class LoggingSystem

get

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getSystemProperties

public LoggingSystemProperties getSystemProperties(ConfigurableEnvironment environment)

Description copied from class: LoggingSystem

Return the LoggingSystemProperties that should be applied.

Overrides:

getSystemProperties in class LoggingSystem

Parameters:

environment - the ConfigurableEnvironment used to obtain value

Returns:

the LoggingSystemProperties to apply

getStandardConfigLocations

protected String[] getStandardConfigLocations()

Description copied from class: AbstractLoggingSystem

Return the standard config locations for this system.

Specified by:

getStandardConfigLocations in class AbstractLoggingSystem

Returns:

the standard config locations

See Also:

• AbstractLoggingSystem.getSelfInitializationConfig()

getSelfInitializationConfig

protected @Nullable String getSelfInitializationConfig()

Description copied from class: AbstractLoggingSystem

Return any self initialization config that has been applied. By default this method checks AbstractLoggingSystem.getStandardConfigLocations() and assumes that any file that exists will have been applied.

Overrides:

getSelfInitializationConfig in class AbstractLoggingSystem

Returns:

the self initialization config or null

getSpringInitializationConfig

protected @Nullable String getSpringInitializationConfig()

Description copied from class: AbstractLoggingSystem

Return any spring specific initialization config that should be applied. By default this method checks AbstractLoggingSystem.getSpringConfigLocations().

Overrides:

getSpringInitializationConfig in class AbstractLoggingSystem

Returns:

the spring initialization config or null

beforeInitialize

public void beforeInitialize()

Description copied from class: LoggingSystem

Reset the logging system to be limit output. This method may be called before LoggingSystem.initialize(LoggingInitializationContext, String, LogFile) to reduce logging noise until the system has been fully initialized.

Overrides:

beforeInitialize in class AbstractLoggingSystem

initialize

public void initialize(LoggingInitializationContext initializationContext,
 @Nullable String configLocation,
 @Nullable LogFile logFile)

Description copied from class: LoggingSystem

Fully initialize the logging system.

Overrides:

initialize in class AbstractLoggingSystem

Parameters:

initializationContext - the logging initialization context

configLocation - a log configuration location or null if default initialization is required

logFile - the log output file that should be written or null for console only output

loadDefaults

protected void loadDefaults(LoggingInitializationContext initializationContext,
 @Nullable LogFile logFile)

Description copied from class: AbstractLoggingSystem

Load sensible defaults for the logging system.

Specified by:

loadDefaults in class AbstractLoggingSystem

Parameters:

initializationContext - the logging initialization context

logFile - the file to load or null if no log file is to be written

loadConfiguration

protected void loadConfiguration(LoggingInitializationContext initializationContext,
 String location,
 @Nullable LogFile logFile)

Description copied from class: AbstractLoggingSystem

Load a specific configuration.

Specified by:

loadConfiguration in class AbstractLoggingSystem

Parameters:

initializationContext - the logging initialization context

location - the location of the configuration to load (never null)

logFile - the file to load or null if no log file is to be written

reinitialize

protected void reinitialize(LoggingInitializationContext initializationContext)

Description copied from class: AbstractLoggingSystem

Reinitialize the logging system if required. Called when AbstractLoggingSystem.getSelfInitializationConfig() is used and the log file hasn't changed. May be used to reload configuration (for example to pick up additional System properties).

Overrides:

reinitialize in class AbstractLoggingSystem

Parameters:

initializationContext - the logging initialization context

getSupportedLogLevels

public Set<LogLevel> getSupportedLogLevels()

Description copied from class: LoggingSystem

Returns a set of the LogLevels that are actually supported by the logging system.

Overrides:

getSupportedLogLevels in class LoggingSystem

Returns:

the supported levels

setLogLevel

public void setLogLevel(@Nullable String loggerName,
 @Nullable LogLevel logLevel)

Description copied from class: LoggingSystem

Sets the logging level for a given logger.

Overrides:

setLogLevel in class LoggingSystem

Parameters:

loggerName - the name of the logger to set (null can be used for the root logger).

logLevel - the log level (null can be used to remove any custom level for the logger and use the default configuration instead)

getLoggerConfigurations

public List<LoggerConfiguration> getLoggerConfigurations()

Description copied from class: LoggingSystem

Returns a collection of the current configuration for all a LoggingSystem's loggers.

Overrides:

getLoggerConfigurations in class LoggingSystem

Returns:

the current configurations

getLoggerConfiguration

public @Nullable LoggerConfiguration getLoggerConfiguration(String loggerName)

Description copied from class: LoggingSystem

Returns the current configuration for a LoggingSystem's logger.

Overrides:

getLoggerConfiguration in class LoggingSystem

Parameters:

loggerName - the name of the logger

Returns:

the current configuration

getShutdownHandler

public Runnable getShutdownHandler()

Description copied from class: LoggingSystem

Returns a Runnable that can handle shutdown of this logging system when the JVM exits. The default implementation returns null, indicating that no shutdown is required.

Overrides:

getShutdownHandler in class LoggingSystem

Returns:

the shutdown handler, or null

cleanUp

public void cleanUp()

Description copied from class: LoggingSystem

Clean up the logging system. The default implementation does nothing. Subclasses should override this method to perform any logging system-specific cleanup.

Overrides:

cleanUp in class LoggingSystem

getDefaultLogCorrelationPattern

protected String getDefaultLogCorrelationPattern()

Description copied from class: AbstractLoggingSystem

Return the default log correlation pattern or null if log correlation patterns are not supported.

Overrides:

getDefaultLogCorrelationPattern in class AbstractLoggingSystem

Returns:

the default log correlation pattern

getEnvironment

public static @Nullable Environment getEnvironment(@Nullable LoggerContext loggerContext)

Get the Spring Environment attached to the given LoggerContext or null if no environment is available.

Parameters:

loggerContext - the logger context

Returns:

the Spring Environment or null

Since:

3.0.0