org.springframework.boot.logging

Class LoggingApplicationListener

java.lang.Object

org.springframework.boot.logging.LoggingApplicationListener

All Implemented Interfaces:

EventListener, ApplicationListener<ApplicationEvent>, GenericApplicationListener, Ordered

public class LoggingApplicationListener
extends Object
implements GenericApplicationListener

An ApplicationListener that configures the LoggingSystem. If the environment contains a logging.config property a then that will be used to initialize the logging system, otherwise a default configuration is used.

By default, log output is only written to the console. If a log file is required the logging.path and logging.file properties can be used.

Some system properties may be set as side effects, and these can be useful if the logging configuration supports placeholders (i.e. log4j or logback):

• LOG_FILE is set to the value of path of the log file that should be written (if any).
• PID is set to the value of the current process ID if it can be determined.

Author:

Dave Syer, Phillip Webb, Andy Wilkinson

See Also:

LoggingSystem.get(ClassLoader)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PROPERTY The name of the Spring property that contains a reference to the logging configuration to load.
static int	DEFAULT_ORDER The default order for the LoggingApplicationListener.
static String	EXCEPTION_CONVERSION_WORD The name of the System property that contains the exception conversion word.
static String	FILE_PROPERTY The name of the Spring property that contains the name of the logging configuration file.
static String	PATH_PROPERTY The name of the Spring property that contains the path where the logging configuration can be found.
static String	PID_KEY The name of the System property that contains the process ID.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
LoggingApplicationListener()

Method Summary

Modifier and Type	Method and Description
int	getOrder()
protected void	initialize(ConfigurableEnvironment environment, ClassLoader classLoader) Initialize the logging system according to preferences expressed through the Environment and the classpath.
protected void	initializeLogLevel(LoggingSystem system, LogLevel level)
void	onApplicationEvent(ApplicationEvent event)
protected void	setLogLevels(LoggingSystem system, Environment environment)
void	setOrder(int order)
void	setParseArgs(boolean parseArgs) Sets if initialization arguments should be parsed for --debug and --trace options.
void	setSpringBootLogging(LogLevel springBootLogging) Sets a custom logging level to be used for Spring Boot and related libraries.
boolean	supportsEventType(ResolvableType resolvableType)
boolean	supportsSourceType(Class<?> sourceType)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

The default order for the LoggingApplicationListener.

See Also:

Constant Field Values

CONFIG_PROPERTY

public static final String CONFIG_PROPERTY

The name of the Spring property that contains a reference to the logging configuration to load.

See Also:

Constant Field Values

PATH_PROPERTY

public static final String PATH_PROPERTY

The name of the Spring property that contains the path where the logging configuration can be found.

See Also:

Constant Field Values

FILE_PROPERTY

public static final String FILE_PROPERTY

The name of the Spring property that contains the name of the logging configuration file.

See Also:

Constant Field Values

PID_KEY

public static final String PID_KEY

The name of the System property that contains the process ID.

See Also:

Constant Field Values

EXCEPTION_CONVERSION_WORD

public static final String EXCEPTION_CONVERSION_WORD

The name of the System property that contains the exception conversion word.

See Also:

Constant Field Values

Constructor Detail

LoggingApplicationListener

public LoggingApplicationListener()

Method Detail

supportsEventType

public boolean supportsEventType(ResolvableType resolvableType)

Specified by:

supportsEventType in interface GenericApplicationListener

supportsSourceType

public boolean supportsSourceType(Class<?> sourceType)

Specified by:

supportsSourceType in interface GenericApplicationListener

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationEvent>

initialize

protected void initialize(ConfigurableEnvironment environment,
                          ClassLoader classLoader)

Initialize the logging system according to preferences expressed through the Environment and the classpath.

Parameters:

environment - the environment

classLoader - the classloader

initializeLogLevel

protected void initializeLogLevel(LoggingSystem system,
                                  LogLevel level)

setLogLevels

protected void setLogLevels(LoggingSystem system,
                            Environment environment)

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setSpringBootLogging

public void setSpringBootLogging(LogLevel springBootLogging)

Sets a custom logging level to be used for Spring Boot and related libraries.

Parameters:

springBootLogging - the logging level

setParseArgs

public void setParseArgs(boolean parseArgs)

Sets if initialization arguments should be parsed for --debug and --trace options. Defaults to true.

Parameters:

parseArgs - if arguments should be parsed