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 RingBufferLogEvent s. |
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.
|
void |
execute(boolean endOfBatch)
Event processor that reads the event from the ringbuffer can call this
method.
|
Map<String,String> |
getContextMap()
Get the MDC data.
|
ThreadContext.ContextStack |
getContextStack()
Get the NDC data.
|
String |
getFQCN()
Returns the fully qualified class name of the caller of the logging api.
|
Level |
getLevel()
Get level.
|
String |
getLoggerName()
Get logger name.
|
Marker |
getMarker()
Get the Marker associated with the event.
|
Message |
getMessage()
Get the message associated with the event.
|
long |
getMillis()
Get event time in milliseconds since 1970.
|
StackTraceElement |
getSource()
Get source of logging request.
|
String |
getThreadName()
Get thread name.
|
Throwable |
getThrown()
Get throwable associated with logging request.
|
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 t,
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 RingBufferLogEvent
s.public void setValues(AsyncLogger asyncLogger, String loggerName, Marker marker, String fqcn, Level level, Message data, Throwable t, 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 LogEvent
true
if this event is the end of a batch, false
otherwisepublic void setEndOfBatch(boolean endOfBatch)
LogEvent
immediateFlush=true
configuration.setEndOfBatch
in interface LogEvent
endOfBatch
- true
if this event is the last one in a batch,
false
otherwise.public boolean isIncludeLocation()
LogEvent
StackTrace
snapshot or not before handing off this
event to another thread.isIncludeLocation
in interface LogEvent
true
if the source of the logging request is required
downstream, false
otherwise.LogEvent.getSource()
public void setIncludeLocation(boolean includeLocation)
LogEvent
StackTrace
snapshot or not before handing off this
event to another thread.setIncludeLocation
in interface LogEvent
includeLocation
- true
if the source of the logging request
is required downstream, false
otherwise.LogEvent.getSource()
public String getLoggerName()
LogEvent
getLoggerName
in interface LogEvent
public Marker getMarker()
LogEvent
public String getFQCN()
LogEvent
public Message getMessage()
LogEvent
getMessage
in interface LogEvent
public Throwable getThrown()
LogEvent
public Map<String,String> getContextMap()
LogEvent
getContextMap
in interface LogEvent
public ThreadContext.ContextStack getContextStack()
LogEvent
getContextStack
in interface LogEvent
public String getThreadName()
LogEvent
getThreadName
in interface LogEvent
public StackTraceElement getSource()
LogEvent
public long getMillis()
LogEvent
public void mergePropertiesIntoContextMap(Map<Property,Boolean> properties, StrSubstitutor strSubstitutor)
properties
- configured propertiesstrSubstitutor
- used to lookup values of variables in propertiespublic void clear()
Copyright © 1999-2014 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.