spring-boot/org.springframework.boot.logging/LoggingSystem

LoggingSystem

abstract class LoggingSystem

Common abstraction over logging systems.

Author

Phillip Webb

Dave Syer

Andy Wilkinson

Ben Hale

Since

1.0.0

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
val EXPECT_CORRELATION_ID_PROPERTY: String = "logging.expect-correlation-id"
The name of an Environment property used to indicate that a correlation ID is expected to be logged at some point.
Link copied to clipboard
val NONE: String = "none"
The value of the SYSTEM_PROPERTY that can be used to indicate that no LoggingSystem should be used.
Link copied to clipboard
val ROOT_LOGGER_NAME: String = "ROOT"
The name used for the root logger.
Link copied to clipboard
val SYSTEM_PROPERTY: String
A System property that can be used to indicate the LoggingSystem to use.

Functions

Link copied to clipboard
abstract fun beforeInitialize()
Reset the logging system to be limit output.
Link copied to clipboard
open fun cleanUp()
Clean up the logging system.
Link copied to clipboard
open fun get(classLoader: ClassLoader): LoggingSystem
Detect and return the logging system in use.
Link copied to clipboard
open fun getLoggerConfiguration(loggerName: String): LoggerConfiguration
Returns the current configuration for a LoggingSystem's logger.
Link copied to clipboard
open fun getLoggerConfigurations(): List<LoggerConfiguration>
Returns a collection of the current configuration for all a LoggingSystem's loggers.
Link copied to clipboard
open fun getShutdownHandler(): Runnable
Returns a Runnable that can handle shutdown of this logging system when the JVM exits.
Link copied to clipboard
open fun getSupportedLogLevels(): Set<LogLevel>
Returns a set of the LogLevels that are actually supported by the logging system.
Link copied to clipboard
open fun getSystemProperties(environment: ConfigurableEnvironment): LoggingSystemProperties
Return the LoggingSystemProperties that should be applied.
Link copied to clipboard
open fun initialize(initializationContext: LoggingInitializationContext, configLocation: String, logFile: LogFile)
Fully initialize the logging system.
Link copied to clipboard
open fun setLogLevel(loggerName: String, level: LogLevel)
Sets the logging level for a given logger.