public class RingBufferLogEvent extends Object implements LogEvent
| Modifier and Type | Field and Description |
|---|---|
static org.apache.logging.log4j.core.async.RingBufferLogEvent.Factory |
FACTORY
The
EventFactory for RingBufferLogEvents. |
| Constructor and Description |
|---|
RingBufferLogEvent() |
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Release references held by ring buffer to allow objects to be garbage-collected.
|
LogEvent |
createMemento()
Creates and returns a new immutable copy of this
RingBufferLogEvent. |
void |
execute(boolean endOfBatch)
Event processor that reads the event from the ringbuffer can call this method.
|
Map<String,String> |
getContextMap()
Gets the context map (also know as Mapped Diagnostic Context or MDC).
|
ThreadContext.ContextStack |
getContextStack()
Gets the context stack (also known as Nested Diagnostic Context or NDC).
|
Level |
getLevel()
Gets the level.
|
String |
getLoggerFqcn()
Returns the fully qualified class name of the caller of the logging API.
|
String |
getLoggerName()
Gets the logger name.
|
Marker |
getMarker()
Gets the Marker associated with the event.
|
Message |
getMessage()
Gets the message associated with the event.
|
StackTraceElement |
getSource()
Gets the source of logging request.
|
String |
getThreadName()
Gets thread name.
|
Throwable |
getThrown()
Gets throwable associated with logging request.
|
ThrowableProxy |
getThrownProxy()
Gets throwable proxy associated with logging request.
|
long |
getTimeMillis()
Gets event time in milliseconds since midnight, January 1, 1970 UTC.
|
boolean |
isEndOfBatch()
Returns
true if this event is the end of a batch, false otherwise. |
boolean |
isIncludeLocation()
Returns whether the source of the logging request is required downstream.
|
void |
mergePropertiesIntoContextMap(Map<Property,Boolean> properties,
StrSubstitutor strSubstitutor)
Merges the contents of the specified map into the contextMap, after replacing any variables in the property
values with the StrSubstitutor-supplied actual values.
|
void |
setEndOfBatch(boolean endOfBatch)
Sets whether this event is the last one in a batch.
|
void |
setIncludeLocation(boolean includeLocation)
Sets whether the source of the logging request is required downstream.
|
void |
setValues(AsyncLogger asyncLogger,
String loggerName,
Marker marker,
String fqcn,
Level level,
Message data,
Throwable throwable,
Map<String,String> map,
ThreadContext.ContextStack contextStack,
String threadName,
StackTraceElement location,
long currentTimeMillis) |
public static final org.apache.logging.log4j.core.async.RingBufferLogEvent.Factory FACTORY
EventFactory for RingBufferLogEvents.public void setValues(AsyncLogger asyncLogger, String loggerName, Marker marker, String fqcn, Level level, Message data, Throwable throwable, Map<String,String> map, ThreadContext.ContextStack contextStack, String threadName, StackTraceElement location, long currentTimeMillis)
public void execute(boolean endOfBatch)
endOfBatch - flag to indicate if this is the last event in a batch from the RingBufferpublic boolean isEndOfBatch()
true if this event is the end of a batch, false otherwise.isEndOfBatch in interface LogEventtrue if this event is the end of a batch, false otherwisepublic void setEndOfBatch(boolean endOfBatch)
LogEventimmediateFlush=true configuration.setEndOfBatch in interface LogEventendOfBatch - true if this event is the last one in a batch, false otherwise.public boolean isIncludeLocation()
LogEventStackTrace snapshot or not before handing off this event to
another thread.isIncludeLocation in interface LogEventtrue if the source of the logging request is required downstream, false otherwise.LogEvent.getSource()public void setIncludeLocation(boolean includeLocation)
LogEventStackTrace snapshot or not before handing off this event to
another thread.setIncludeLocation in interface LogEventincludeLocation - true if the source of the logging request is required downstream, false
otherwise.LogEvent.getSource()public String getLoggerName()
LogEventgetLoggerName in interface LogEventnull.public Marker getMarker()
LogEventpublic String getLoggerFqcn()
LogEventgetLoggerFqcn in interface LogEventpublic Message getMessage()
LogEventgetMessage in interface LogEventpublic Throwable getThrown()
LogEventConvenience method for ThrowableProxy.getThrowable();
public ThrowableProxy getThrownProxy()
LogEventgetThrownProxy in interface LogEventpublic Map<String,String> getContextMap()
LogEventgetContextMap in interface LogEventnull.public ThreadContext.ContextStack getContextStack()
LogEventgetContextStack in interface LogEventnull.public String getThreadName()
LogEventgetThreadName in interface LogEventpublic StackTraceElement getSource()
LogEventpublic long getTimeMillis()
LogEventgetTimeMillis in interface LogEventSystem.currentTimeMillis()public void mergePropertiesIntoContextMap(Map<Property,Boolean> properties, StrSubstitutor strSubstitutor)
properties - configured propertiesstrSubstitutor - used to lookup values of variables in propertiespublic void clear()
public LogEvent createMemento()
RingBufferLogEvent.RingBufferLogEventCopyright © 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.