org.springframework.boot.logging

Class LoggingApplicationListener

java.lang.Object

org.springframework.boot.logging.LoggingApplicationListener

All Implemented Interfaces:

EventListener, ApplicationListener<ApplicationEvent>, SmartApplicationListener, Ordered

public class LoggingApplicationListener
extends Object
implements SmartApplicationListener

An ApplicationListener that configures a logging framework depending on what it finds on the classpath and in the Environment. If the environment contains a property logging.config then that will be used to initialize the logging system, otherwise a default location is used. The classpath is probed for log4j and logback and if those are present they will be reconfigured, otherwise vanilla java.util.logging will be used.

The default config locations are classpath:log4j.properties or classpath:log4j.xml for log4j; classpath:logback.xml for logback; and classpath:logging.properties for java.util.logging. If the correct one of those files is not found then some sensible defaults are adopted from files of the same name but in the package containing LoggingApplicationListener.

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 logging.file if found in the environment
• LOG_PATH is set to the value of logging.path if found in the environment
• PID is set to the value of the current process ID if it can be determined

Author:

Dave Syer, Phillip Webb

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
LoggingApplicationListener()

Method Summary

Methods

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)
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(Class<? extends ApplicationEvent> eventType)
boolean	supportsSourceType(Class<?> sourceType)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingApplicationListener

public LoggingApplicationListener()

Method Detail

supportsEventType

public boolean supportsEventType(Class<? extends ApplicationEvent> eventType)

Specified by:

supportsEventType in interface SmartApplicationListener

supportsSourceType

public boolean supportsSourceType(Class<?> sourceType)

Specified by:

supportsSourceType in interface SmartApplicationListener

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.

initializeLogLevel

protected void initializeLogLevel(LoggingSystem system,
                      LogLevel level)

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