public interface LogEvent extends Serializable
Serializable so that it
may be transmitted over a network connection, output in a
SerializedLayout, and many other uses. Besides containing a
Message, a LogEvent has a corresponding
Level that the message was logged at. If a
Marker was used, then it is included here. The contents of the
ThreadContext at the time of the log call are provided via
getContextMap() and getContextStack(). If a Throwable was included in the log
call, then it is provided via getThrown(). When this class is serialized, the attached Throwable will
be wrapped into a ThrowableProxy so that it may be safely serialized
and deserialized properly without causing problems if the exception class is not available on the other end.| Modifier and Type | Method and Description |
|---|---|
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 last one in a batch, false otherwise. |
boolean |
isIncludeLocation()
Returns whether the source of the logging request is required downstream.
|
void |
setEndOfBatch(boolean endOfBatch)
Sets whether this event is the last one in a batch.
|
void |
setIncludeLocation(boolean locationRequired)
Sets whether the source of the logging request is required downstream.
|
Map<String,String> getContextMap()
null.ThreadContext.ContextStack getContextStack()
null.String getLoggerFqcn()
Level getLevel()
String getLoggerName()
null.Marker getMarker()
null if no Marker was defined on this LogEventMessage getMessage()
long getTimeMillis()
System.currentTimeMillis()StackTraceElement getSource()
String getThreadName()
Throwable getThrown()
Convenience method for ThrowableProxy.getThrowable();
ThrowableProxy getThrownProxy()
boolean isEndOfBatch()
true if this event is the last one in a batch, false otherwise. Used by asynchronous
Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient
alternative to the immediateFlush=true configuration.boolean isIncludeLocation()
StackTrace snapshot or not before handing off this event to
another thread.true if the source of the logging request is required downstream, false otherwise.getSource()void setEndOfBatch(boolean endOfBatch)
immediateFlush=true configuration.endOfBatch - true if this event is the last one in a batch, false otherwise.void setIncludeLocation(boolean locationRequired)
StackTrace snapshot or not before handing off this event to
another thread.locationRequired - true if the source of the logging request is required downstream, false
otherwise.getSource()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.