Package org.springframework.boot.logging.logback

Class LogbackLoggingSystem

java.lang.Object

org.springframework.boot.logging.LoggingSystem

org.springframework.boot.logging.AbstractLoggingSystem

org.springframework.boot.logging.logback.LogbackLoggingSystem

All Implemented Interfaces:

BeanFactoryInitializationAotProcessor

public class LogbackLoggingSystem
extends AbstractLoggingSystem
implements BeanFactoryInitializationAotProcessor

LoggingSystem for logback.

Since:

1.0.0

Author:

Phillip Webb, Dave Syer, Andy Wilkinson, Ben Hale

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.springframework.boot.logging.AbstractLoggingSystem

AbstractLoggingSystem.LogLevels<T>

Field Summary

Fields inherited from class org.springframework.boot.logging.AbstractLoggingSystem

CONFIGURATION_COMPARATOR

Fields inherited from class org.springframework.boot.logging.LoggingSystem

EXPECT_CORRELATION_ID_PROPERTY, NONE, ROOT_LOGGER_NAME, SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor	Description
LogbackLoggingSystem(ClassLoader classLoader)

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.
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.
Runnable	getShutdownHandler()	Returns a Runnable that can handle shutdown of this logging system when the JVM exits.
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, String configLocation, LogFile logFile)	Fully initialize the logging system.
protected void	loadConfiguration(LoggingInitializationContext initializationContext, String location, LogFile logFile)	Load a specific configuration.
protected void	loadDefaults(LoggingInitializationContext initializationContext, LogFile logFile)	Load sensible defaults for the logging system.
BeanFactoryInitializationAotContribution	processAheadOfTime(ConfigurableListableBeanFactory beanFactory)
protected void	reinitialize(LoggingInitializationContext initializationContext)	Reinitialize the logging system if required.
void	setLogLevel(String loggerName, LogLevel level)	Sets the logging level for a given logger.

Methods inherited from class org.springframework.boot.logging.AbstractLoggingSystem

applySystemProperties, getClassLoader, getDefaultValueResolver, getPackagedConfigFile, getSelfInitializationConfig, getSpringConfigLocations, getSpringInitializationConfig

Methods inherited from class org.springframework.boot.logging.LoggingSystem

get

Methods inherited from class java.lang.Object

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

Constructor Details

LogbackLoggingSystem

public LogbackLoggingSystem(ClassLoader classLoader)

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()

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,
 String configLocation,
 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,
 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,
 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

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

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

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 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

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(String loggerName,
 LogLevel level)

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).

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

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

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

processAheadOfTime

public BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableListableBeanFactory beanFactory)

Specified by:

processAheadOfTime in interface BeanFactoryInitializationAotProcessor