public class AsyncLogger extends Logger
To use AsyncLogger, specify the System property
-DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
before you obtain a Logger, and all Loggers returned by LogManager.getLogger
will be AsyncLoggers.
Note that for performance reasons, this logger does not include source
location by default. You need to specify includeLocation="true"
in
the configuration or any %class, %location or %line conversion patterns in
your log4j.xml configuration will produce either a "?" character or no output
at all.
For best performance, use AsyncLogger with the RandomAccessFileAppender or RollingRandomAccessFileAppender, with immediateFlush=false. These appenders have built-in support for the batching mechanism used by the Disruptor library, and they will flush to disk at the end of each batch. This means that even with immediateFlush=false, there will never be any items left in the buffer; all log events will all be written to disk in a very efficient manner.
Logger.PrivateConfig
Constructor and Description |
---|
AsyncLogger(LoggerContext context,
String name,
org.apache.logging.log4j.message.MessageFactory messageFactory)
Constructs an
AsyncLogger with the specified context, name and
message factory. |
Modifier and Type | Method and Description |
---|---|
void |
actualAsyncLog(RingBufferLogEvent event)
This method is called by the EventHandler that processes the
RingBufferLogEvent in a separate thread.
|
static RingBufferAdmin |
createRingBufferAdmin(String contextName)
Creates and returns a new
RingBufferAdmin that instruments the
ringbuffer of the AsyncLogger . |
void |
logMessage(String fqcn,
org.apache.logging.log4j.Level level,
org.apache.logging.log4j.Marker marker,
org.apache.logging.log4j.message.Message message,
Throwable thrown) |
static void |
stop() |
addAppender, addFilter, filterCount, getAppenders, getContext, getFilters, getLevel, getParent, isAdditive, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, removeAppender, setAdditive, setLevel, toString, updateConfiguration
catching, catching, catching, catchingMsg, checkMessageFactory, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, entry, entry, entry, entryMsg, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, exit, exitMsg, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, getMessageFactory, getName, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isEnabled, isEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logMessage, logMessage, logMessage, logMessage, printf, printf, throwing, throwing, throwing, throwingMsg, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn
public AsyncLogger(LoggerContext context, String name, org.apache.logging.log4j.message.MessageFactory messageFactory)
AsyncLogger
with the specified context, name and
message factory.context
- context of this loggername
- name of this loggermessageFactory
- message factory of this loggerpublic void logMessage(String fqcn, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message message, Throwable thrown)
logMessage
in interface org.apache.logging.log4j.spi.ExtendedLogger
logMessage
in class Logger
public void actualAsyncLog(RingBufferLogEvent event)
event
- the event to logpublic static void stop()
public static RingBufferAdmin createRingBufferAdmin(String contextName)
RingBufferAdmin
that instruments the
ringbuffer of the AsyncLogger
.contextName
- name of the global AsyncLoggerContext
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.