Package 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	Description
static class	AsyncLoggerConfigDisruptor.Log4jEventWrapper	RingBuffer events contain all information necessary to perform the work in a separate thread.
private static class	AsyncLoggerConfigDisruptor.Log4jEventWrapperHandler	EventHandler performs the work in a separate thread.

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

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	alreadyLoggedWarning
private AsyncQueueFullPolicy	asyncQueueFullPolicy
private AsyncWaitStrategyFactory	asyncWaitStrategyFactory
private long	backgroundThreadId
private com.lmax.disruptor.dsl.Disruptor<AsyncLoggerConfigDisruptor.Log4jEventWrapper>	disruptor
private com.lmax.disruptor.EventFactory<AsyncLoggerConfigDisruptor.Log4jEventWrapper>	factory
private static com.lmax.disruptor.EventFactory<AsyncLoggerConfigDisruptor.Log4jEventWrapper>	FACTORY	Factory used to populate the RingBuffer with events.
private static int	MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN
private java.lang.Boolean	mutable
private static com.lmax.disruptor.EventFactory<AsyncLoggerConfigDisruptor.Log4jEventWrapper>	MUTABLE_FACTORY	Factory used to populate the RingBuffer with events.
private static com.lmax.disruptor.EventTranslatorTwoArg<AsyncLoggerConfigDisruptor.Log4jEventWrapper,LogEvent,AsyncLoggerConfig>	MUTABLE_TRANSLATOR	Object responsible for passing on data to a RingBuffer event with a MutableLogEvent.
private java.lang.Object	queueFullEnqueueLock
private int	ringBufferSize
private static int	SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS
private com.lmax.disruptor.EventTranslatorTwoArg<AsyncLoggerConfigDisruptor.Log4jEventWrapper,LogEvent,AsyncLoggerConfig>	translator
private static com.lmax.disruptor.EventTranslatorTwoArg<AsyncLoggerConfigDisruptor.Log4jEventWrapper,LogEvent,AsyncLoggerConfig>	TRANSLATOR	Object responsible for passing on data to a specific RingBuffer event.
private com.lmax.disruptor.WaitStrategy	waitStrategy

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

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Constructor Summary

Constructors

Constructor	Description
AsyncLoggerConfigDisruptor(AsyncWaitStrategyFactory asyncWaitStrategyFactory)

Method Summary

Modifier and Type	Method	Description
RingBufferAdmin	createRingBufferAdmin(java.lang.String contextName, java.lang.String loggerConfigName)	Creates and returns a new RingBufferAdmin that instruments the ringbuffer of this AsyncLoggerConfig.
private void	enqueue(LogEvent logEvent, AsyncLoggerConfig asyncLoggerConfig)
void	enqueueEvent(LogEvent event, AsyncLoggerConfig asyncLoggerConfig)	Enqueues the LogEvent on the mixed configuration ringbuffer.
private LogEvent	ensureImmutable(LogEvent event)
EventRoute	getEventRoute(Level logLevel)	Returns the EventRoute for the event with the specified level.
(package private) com.lmax.disruptor.WaitStrategy	getWaitStrategy()
private static boolean	hasBacklog(com.lmax.disruptor.dsl.Disruptor<?> theDisruptor)	Returns true if the specified disruptor still has unprocessed events.
private boolean	hasLog4jBeenShutDown(com.lmax.disruptor.dsl.Disruptor<AsyncLoggerConfigDisruptor.Log4jEventWrapper> aDisruptor)	Returns true if the specified disruptor is null.
private LogEvent	prepareEvent(LogEvent event)
private int	remainingDisruptorCapacity()
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.
private void	showWarningAboutCustomLogEventWithReusableMessage(LogEvent logEvent)
void	start()	Increases the reference count and creates and starts a new Disruptor and associated thread if none currently exists.
boolean	stop(long timeout, java.util.concurrent.TimeUnit timeUnit)	Decreases the reference count.
private boolean	synchronizeEnqueueWhenQueueFull()
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

Field Detail

MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN

private static final int MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN

See Also:

Constant Field Values

SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS

private static final int SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS

See Also:

Constant Field Values

FACTORY

private static final com.lmax.disruptor.EventFactory<AsyncLoggerConfigDisruptor.Log4jEventWrapper> FACTORY

Factory used to populate the RingBuffer with events. These event objects are then re-used during the life of the RingBuffer.

MUTABLE_FACTORY

private static final com.lmax.disruptor.EventFactory<AsyncLoggerConfigDisruptor.Log4jEventWrapper> MUTABLE_FACTORY

Factory used to populate the RingBuffer with events. These event objects are then re-used during the life of the RingBuffer.

TRANSLATOR

private static final com.lmax.disruptor.EventTranslatorTwoArg<AsyncLoggerConfigDisruptor.Log4jEventWrapper,LogEvent,AsyncLoggerConfig> TRANSLATOR

Object responsible for passing on data to a specific RingBuffer event.

MUTABLE_TRANSLATOR

private static final com.lmax.disruptor.EventTranslatorTwoArg<AsyncLoggerConfigDisruptor.Log4jEventWrapper,LogEvent,AsyncLoggerConfig> MUTABLE_TRANSLATOR

Object responsible for passing on data to a RingBuffer event with a MutableLogEvent.

ringBufferSize

private int ringBufferSize

asyncQueueFullPolicy

private AsyncQueueFullPolicy asyncQueueFullPolicy

mutable

private java.lang.Boolean mutable

disruptor

private volatile com.lmax.disruptor.dsl.Disruptor<AsyncLoggerConfigDisruptor.Log4jEventWrapper> disruptor

backgroundThreadId

private long backgroundThreadId

factory

private com.lmax.disruptor.EventFactory<AsyncLoggerConfigDisruptor.Log4jEventWrapper> factory

translator

private com.lmax.disruptor.EventTranslatorTwoArg<AsyncLoggerConfigDisruptor.Log4jEventWrapper,LogEvent,AsyncLoggerConfig> translator

alreadyLoggedWarning

private volatile boolean alreadyLoggedWarning

asyncWaitStrategyFactory

private final AsyncWaitStrategyFactory asyncWaitStrategyFactory

waitStrategy

private com.lmax.disruptor.WaitStrategy waitStrategy

queueFullEnqueueLock

private final java.lang.Object queueFullEnqueueLock

Constructor Detail

AsyncLoggerConfigDisruptor

public AsyncLoggerConfigDisruptor(AsyncWaitStrategyFactory asyncWaitStrategyFactory)

Method Detail

getWaitStrategy

com.lmax.disruptor.WaitStrategy getWaitStrategy()

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,
                    java.util.concurrent.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.

hasBacklog

private static boolean hasBacklog(com.lmax.disruptor.dsl.Disruptor<?> theDisruptor)

Returns true if the specified disruptor still has unprocessed events.

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

remainingDisruptorCapacity

private int remainingDisruptorCapacity()

hasLog4jBeenShutDown

private boolean hasLog4jBeenShutDown(com.lmax.disruptor.dsl.Disruptor<AsyncLoggerConfigDisruptor.Log4jEventWrapper> aDisruptor)

Returns true if the specified disruptor is null.

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

prepareEvent

private LogEvent prepareEvent(LogEvent event)

showWarningAboutCustomLogEventWithReusableMessage

private void showWarningAboutCustomLogEventWithReusableMessage(LogEvent logEvent)

enqueue

private void enqueue(LogEvent logEvent,
                     AsyncLoggerConfig asyncLoggerConfig)

synchronizeEnqueueWhenQueueFull

private boolean synchronizeEnqueueWhenQueueFull()

tryEnqueue

public boolean tryEnqueue(LogEvent event,
                          AsyncLoggerConfig asyncLoggerConfig)

Specified by:

tryEnqueue in interface AsyncLoggerConfigDelegate

ensureImmutable

private LogEvent ensureImmutable(LogEvent event)

createRingBufferAdmin

public RingBufferAdmin createRingBufferAdmin(java.lang.String contextName,
                                             java.lang.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