org.apache.logging.log4j.core.appender

Class AsyncAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

org.apache.logging.log4j.core.appender.AsyncAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle, LifeCycle2

@Plugin(name="Async",
        category="Core",
        elementType="appender",
        printObject=true)
public final class AsyncAppender
extends AbstractAppender

Appends to one or more Appenders asynchronously. You can configure an AsyncAppender with one or more Appenders and an Appender to append to if the queue is full. The AsyncAppender does not allow a filter to be specified on the Appender references.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsyncAppender.Builder<B extends AsyncAppender.Builder<B>>

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

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
void	append(LogEvent logEvent) Actual writing occurs here.
static AsyncAppender	createAppender(AppenderRef[] appenderRefs, String errorRef, boolean blocking, long shutdownTimeout, int size, String name, boolean includeLocation, Filter filter, Configuration config, boolean ignoreExceptions) Deprecated. use AsyncAppender.Builder instead
String[]	getAppenderRefStrings() Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.
String	getErrorRef() Returns the name of the appender that any errors are logged to or null.
int	getQueueCapacity()
int	getQueueRemainingCapacity()
int	getQueueSize() Returns the number of elements in the queue.
boolean	isBlocking() Returns true if this AsyncAppender will block when the queue is full, or false if events are dropped when the queue is full.
boolean	isIncludeLocation() Returns true if this AsyncAppender will take a snapshot of the stack with every log event to determine the class and method where the logging call was made.
void	logMessageInBackgroundThread(LogEvent logEvent) FOR INTERNAL USE ONLY.
void	logMessageInCurrentThread(LogEvent logEvent) FOR INTERNAL USE ONLY.
static AsyncAppender.Builder	newBuilder()
void	start() Make the Filter available for use.
boolean	stop(long timeout, TimeUnit timeUnit) Cleanup the Filter.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toSerializable, toString

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, stop

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, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, stop

Method Detail

start

public void start()

Description copied from class: AbstractFilterable

Make the Filter available for use.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractFilterable

stop

public boolean stop(long timeout,
                    TimeUnit timeUnit)

Description copied from class: AbstractFilterable

Cleanup the Filter.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractFilterable

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.

append

public void append(LogEvent logEvent)

Actual writing occurs here.

Parameters:

logEvent - The LogEvent.

logMessageInCurrentThread

public void logMessageInCurrentThread(LogEvent logEvent)

FOR INTERNAL USE ONLY.

Parameters:

logEvent - the event to log

logMessageInBackgroundThread

public void logMessageInBackgroundThread(LogEvent logEvent)

FOR INTERNAL USE ONLY.

Parameters:

logEvent - the event to log

createAppender

@Deprecated
public static AsyncAppender createAppender(AppenderRef[] appenderRefs,
                                                       String errorRef,
                                                       boolean blocking,
                                                       long shutdownTimeout,
                                                       int size,
                                                       String name,
                                                       boolean includeLocation,
                                                       Filter filter,
                                                       Configuration config,
                                                       boolean ignoreExceptions)

Deprecated. use AsyncAppender.Builder instead

Create an AsyncAppender. This method is retained for backwards compatibility. New code should use the AsyncAppender.Builder instead. This factory will use ArrayBlockingQueueFactory by default as was the behavior pre-2.7.

Parameters:

appenderRefs - The Appenders to reference.

errorRef - An optional Appender to write to if the queue is full or other errors occur.

blocking - True if the Appender should wait when the queue is full. The default is true.

shutdownTimeout - How many milliseconds the Appender should wait to flush outstanding log events in the queue on shutdown. The default is zero which means to wait forever.

size - The size of the event queue. The default is 128.

name - The name of the Appender.

includeLocation - whether to include location information. The default is false.

filter - The Filter or null.

config - The Configuration.

ignoreExceptions - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

Returns:

The AsyncAppender.

newBuilder

@PluginBuilderFactory
public static AsyncAppender.Builder newBuilder()

getAppenderRefStrings

public String[] getAppenderRefStrings()

Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.

Returns:

the names of the sink appenders

isIncludeLocation

public boolean isIncludeLocation()

Returns true if this AsyncAppender will take a snapshot of the stack with every log event to determine the class and method where the logging call was made.

Returns:

true if location is included with every event, false otherwise

isBlocking

public boolean isBlocking()

Returns true if this AsyncAppender will block when the queue is full, or false if events are dropped when the queue is full.

Returns:

whether this AsyncAppender will block or drop events when the queue is full.

getErrorRef

public String getErrorRef()

Returns the name of the appender that any errors are logged to or null.

Returns:

the name of the appender that any errors are logged to or null

getQueueCapacity

public int getQueueCapacity()

getQueueRemainingCapacity

public int getQueueRemainingCapacity()

getQueueSize

public int getQueueSize()

Returns the number of elements in the queue.

Returns:

the number of elements in the queue.

Since:

2.11.1