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 theAsyncLoggerConfig
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. IfAsyncLoggerConfig
has inner classes that extend or implement classes from the Disruptor library, aNoClassDefFoundError
is thrown if the Disruptor jar is not in the classpath when the PluginManager loads theAsyncLoggerConfig
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.-
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 Description AsyncLoggerConfigDisruptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RingBufferAdmin
createRingBufferAdmin(String contextName, String loggerConfigName)
Creates and returns a newRingBufferAdmin
that instruments the ringbuffer of thisAsyncLoggerConfig
.void
enqueueEvent(LogEvent event, AsyncLoggerConfig asyncLoggerConfig)
Enqueues theLogEvent
on the mixed configuration ringbuffer.EventRoute
getEventRoute(Level logLevel)
Returns theEventRoute
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
-
-
-
-
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 interfaceAsyncLoggerConfigDelegate
- 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 interfaceLifeCycle
- Overrides:
start
in classAbstractLifeCycle
- 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 tonull
.- Specified by:
stop
in interfaceLifeCycle2
- Overrides:
stop
in classAbstractLifeCycle
- Parameters:
timeout
- the maximum time to waittimeUnit
- 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 theEventRoute
for the event with the specified level.- Specified by:
getEventRoute
in interfaceAsyncLoggerConfigDelegate
- 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 theLogEvent
on the mixed configuration ringbuffer. This method must only be used afterAsyncLoggerConfigDelegate.tryEnqueue(LogEvent, AsyncLoggerConfig)
returnsfalse
indicating that the ringbuffer is full, otherwise it may incur unnecessary synchronization.- Specified by:
enqueueEvent
in interfaceAsyncLoggerConfigDelegate
-
tryEnqueue
public boolean tryEnqueue(LogEvent event, AsyncLoggerConfig asyncLoggerConfig)
- Specified by:
tryEnqueue
in interfaceAsyncLoggerConfigDelegate
-
createRingBufferAdmin
public RingBufferAdmin createRingBufferAdmin(String contextName, String loggerConfigName)
Description copied from interface:AsyncLoggerConfigDelegate
Creates and returns a newRingBufferAdmin
that instruments the ringbuffer of thisAsyncLoggerConfig
.- Specified by:
createRingBufferAdmin
in interfaceAsyncLoggerConfigDelegate
- Parameters:
contextName
- name of theLoggerContext
loggerConfigName
- name of the logger config- Returns:
- the RingBufferAdmin that instruments the ringbuffer
-
-