@Plugin(name="Async", category="Core", elementType="appender", printObject=true) public final class AsyncAppender extends AbstractAppender
LifeCycle.State
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
Modifier and Type | Method and Description |
---|---|
void |
append(LogEvent logEvent)
Actual writing occurs here.
|
static AsyncAppender |
createAppender(AppenderRef[] appenderRefs,
String errorRef,
boolean blocking,
int size,
String name,
boolean includeLocation,
Filter filter,
Configuration config,
boolean ignoreExceptions)
Create an AsyncAppender.
|
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() |
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 |
start()
Make the Filter available for use.
|
void |
stop()
Cleanup the Filter.
|
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString
addFilter, getFilter, hasFilter, isFiltered, removeFilter
equalsImpl, getState, hashCodeImpl, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping
public void start()
AbstractFilterable
start
in interface LifeCycle
start
in class AbstractFilterable
public void stop()
AbstractFilterable
stop
in interface LifeCycle
stop
in class AbstractFilterable
public void append(LogEvent logEvent)
logEvent
- The LogEvent.@PluginFactory public static AsyncAppender createAppender(@PluginElement(value="AppenderRef") AppenderRef[] appenderRefs, @PluginAttribute(value="errorRef") @PluginAliases(value="error-ref") String errorRef, @PluginAttribute(value="blocking",defaultBoolean=true) boolean blocking, @PluginAttribute(value="bufferSize",defaultInt=128) int size, @PluginAttribute(value="name") String name, @PluginAttribute(value="includeLocation",defaultBoolean=false) boolean includeLocation, @PluginElement(value="Filter") Filter filter, @PluginConfiguration Configuration config, @PluginAttribute(value="ignoreExceptions",defaultBoolean=true) boolean ignoreExceptions)
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.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.public String[] getAppenderRefStrings()
public boolean isIncludeLocation()
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.true
if location is included with every event, false
otherwisepublic boolean isBlocking()
true
if this AsyncAppender will block when the queue is full,
or false
if events are dropped when the queue is full.public String getErrorRef()
null
.null
public int getQueueCapacity()
public int getQueueRemainingCapacity()
Copyright © 1999-2021 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.