org.apache.logging.log4j.core.async

Class AsyncLoggerConfigDisruptor

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.async.AsyncLoggerConfigDisruptor

All Implemented Interfaces:

AsyncLoggerConfigDelegate, LifeCycle, LifeCycle2

public class AsyncLoggerConfigDisruptor
extends AbstractLifeCycle
implements AsyncLoggerConfigDelegate

Helper class decoupling the AsyncLoggerConfig class from the LMAX Disruptor library.

AsyncLoggerConfig is a plugin, and will be loaded even if users do not configure any <asyncLogger> or <asyncRoot> elements in the configuration. If AsyncLoggerConfig has inner classes that extend or implement classes from the Disruptor library, a NoClassDefFoundError is thrown if the Disruptor jar is not in the classpath when the PluginManager loads the AsyncLoggerConfig plugin from the pre-defined plugins definition file.

This class serves to make the dependency on the Disruptor optional, so that these classes are only loaded when the AsyncLoggerConfig is actually used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsyncLoggerConfigDisruptor.Log4jEventWrapper RingBuffer events contain all information necessary to perform the work in a separate thread.

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Constructor Summary

Constructors

Constructor and Description
AsyncLoggerConfigDisruptor(AsyncWaitStrategyFactory asyncWaitStrategyFactory)

Method Summary

Modifier and Type	Method and Description
RingBufferAdmin	createRingBufferAdmin(String contextName, String loggerConfigName) Creates and returns a new RingBufferAdmin that instruments the ringbuffer of this AsyncLoggerConfig.
void	enqueueEvent(LogEvent event, AsyncLoggerConfig asyncLoggerConfig) Enqueues the LogEvent on the mixed configuration ringbuffer.
EventRoute	getEventRoute(Level logLevel) Returns the EventRoute for the event with the specified level.
void	setLogEventFactory(LogEventFactory logEventFactory) Notifies the delegate what LogEventFactory an AsyncLoggerConfig is using, so the delegate can determine whether to populate the ring buffer with mutable log events or not.
void	start() Increases the reference count and creates and starts a new Disruptor and associated thread if none currently exists.
boolean	stop(long timeout, TimeUnit timeUnit) Decreases the reference count.
boolean	tryEnqueue(LogEvent event, AsyncLoggerConfig asyncLoggerConfig)

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncLoggerConfigDisruptor

public AsyncLoggerConfigDisruptor(AsyncWaitStrategyFactory asyncWaitStrategyFactory)

Method Detail

setLogEventFactory

public void setLogEventFactory(LogEventFactory logEventFactory)

Description copied from interface: AsyncLoggerConfigDelegate

Notifies the delegate what LogEventFactory an AsyncLoggerConfig is using, so the delegate can determine whether to populate the ring buffer with mutable log events or not. This method may be invoked multiple times for all AsyncLoggerConfigs that use this delegate.

Specified by:

setLogEventFactory in interface AsyncLoggerConfigDelegate

Parameters:

logEventFactory - the factory used

start

public void start()

Increases the reference count and creates and starts a new Disruptor and associated thread if none currently exists.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractLifeCycle

See Also:

AbstractLifeCycle.stop()

stop

public boolean stop(long timeout,
                    TimeUnit timeUnit)

Decreases the reference count. If the reference count reached zero, the Disruptor and its associated thread are shut down and their references set to null.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractLifeCycle

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if the receiver was stopped cleanly and normally, false otherwise.

getEventRoute

public EventRoute getEventRoute(Level logLevel)

Description copied from interface: AsyncLoggerConfigDelegate

Returns the EventRoute for the event with the specified level.

Specified by:

getEventRoute in interface AsyncLoggerConfigDelegate

Parameters:

logLevel - the level of the event to log

Returns:

the EventRoute

enqueueEvent

public void enqueueEvent(LogEvent event,
                         AsyncLoggerConfig asyncLoggerConfig)

Description copied from interface: AsyncLoggerConfigDelegate

Enqueues the LogEvent on the mixed configuration ringbuffer. This method must only be used after AsyncLoggerConfigDelegate.tryEnqueue(LogEvent, AsyncLoggerConfig) returns false indicating that the ringbuffer is full, otherwise it may incur unnecessary synchronization.

Specified by:

enqueueEvent in interface AsyncLoggerConfigDelegate

tryEnqueue

public boolean tryEnqueue(LogEvent event,
                          AsyncLoggerConfig asyncLoggerConfig)

Specified by:

tryEnqueue in interface AsyncLoggerConfigDelegate

createRingBufferAdmin

public RingBufferAdmin createRingBufferAdmin(String contextName,
                                             String loggerConfigName)

Description copied from interface: AsyncLoggerConfigDelegate

Creates and returns a new RingBufferAdmin that instruments the ringbuffer of this AsyncLoggerConfig.

Specified by:

createRingBufferAdmin in interface AsyncLoggerConfigDelegate

Parameters:

contextName - name of the LoggerContext

loggerConfigName - name of the logger config

Returns:

the RingBufferAdmin that instruments the ringbuffer