Class LogEventJsonMixIn
java.lang.Object
org.apache.logging.log4j.core.jackson.LogEventJsonMixIn
- All Implemented Interfaces:
Serializable,LogEvent
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract ReadOnlyStringMapReturns theReadOnlyStringMapobject holding context data key-value pairs.Gets the context map (also know as Mapped Diagnostic Context or MDC).abstract ThreadContext.ContextStackGets the context stack (also known as Nested Diagnostic Context or NDC).abstract InstantReturns the Instant when the message was logged.abstract LevelgetLevel()Gets the level.abstract StringReturns the fully qualified class name of the caller of the logging API.abstract StringGets the logger name.abstract MarkerGets the Marker associated with the event.abstract MessageGets the message associated with the event.abstract StackTraceElementGets the source of logging request.abstract longGets the thread ID.abstract StringGets the thread name.abstract intGets the thread priority.abstract ThrowableGets throwable associated with logging request.abstract ThrowableProxyGets throwable proxy associated with logging request.abstract longGets event time in milliseconds since midnight, January 1, 1970 UTC.abstract booleanReturnstrueif this event is the last one in a batch,falseotherwise.abstract booleanReturns whether the source of the logging request is required downstream.abstract voidsetEndOfBatch(boolean endOfBatch) Sets whether this event is the last one in a batch.abstract voidsetIncludeLocation(boolean locationRequired) Sets whether the source of the logging request is required downstream.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.logging.log4j.core.LogEvent
getNanoTime, toImmutable
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
LogEventJsonMixIn
LogEventJsonMixIn()
-
-
Method Details
-
getContextMap
Description copied from interface:LogEventGets the context map (also know as Mapped Diagnostic Context or MDC).- Specified by:
getContextMapin interfaceLogEvent- Returns:
- The context map, never
null.
-
getContextData
Description copied from interface:LogEventReturns theReadOnlyStringMapobject holding context data key-value pairs.Context data (also known as Mapped Diagnostic Context or MDC) is data that is set by the application to be included in all subsequent log events. The default source for context data is the
ThreadContext(and properties configured on the Logger that logged the event), but users can configure a customContextDataInjectorto inject key-value pairs from any arbitrary source.- Specified by:
getContextDatain interfaceLogEvent- Returns:
- the
ReadOnlyStringMapobject holding context data key-value pairs - See Also:
-
getContextStack
Description copied from interface:LogEventGets the context stack (also known as Nested Diagnostic Context or NDC).- Specified by:
getContextStackin interfaceLogEvent- Returns:
- The context stack, never
null.
-
getLevel
Description copied from interface:LogEventGets the level. -
getLoggerFqcn
Description copied from interface:LogEventReturns the fully qualified class name of the caller of the logging API.- Specified by:
getLoggerFqcnin interfaceLogEvent- Returns:
- The fully qualified class name of the caller.
-
getLoggerName
Description copied from interface:LogEventGets the logger name.- Specified by:
getLoggerNamein interfaceLogEvent- Returns:
- logger name, may be
null.
-
getMarker
Description copied from interface:LogEventGets the Marker associated with the event. -
getMessage
Description copied from interface:LogEventGets the message associated with the event.- Specified by:
getMessagein interfaceLogEvent- Returns:
- message.
-
getSource
Description copied from interface:LogEventGets the source of logging request. -
getThreadId
public abstract long getThreadId()Description copied from interface:LogEventGets the thread ID.- Specified by:
getThreadIdin interfaceLogEvent- Returns:
- thread ID.
-
getThreadName
Description copied from interface:LogEventGets the thread name.- Specified by:
getThreadNamein interfaceLogEvent- Returns:
- thread name, may be null. TODO guess this could go into a thread context object too. (RG) Why?
-
getThreadPriority
public abstract int getThreadPriority()Description copied from interface:LogEventGets the thread priority.- Specified by:
getThreadPriorityin interfaceLogEvent- Returns:
- thread priority.
-
getThrown
Description copied from interface:LogEventGets throwable associated with logging request.Convenience method for
ThrowableProxy.getThrowable(); -
getThrownProxy
Description copied from interface:LogEventGets throwable proxy associated with logging request.- Specified by:
getThrownProxyin interfaceLogEvent- Returns:
- throwable, may be null.
-
getTimeMillis
public abstract long getTimeMillis()Description copied from interface:LogEventGets event time in milliseconds since midnight, January 1, 1970 UTC. UseLogEvent.getInstant()to get higher precision timestamp information if available on this platform.- Specified by:
getTimeMillisin interfaceLogEvent- Returns:
- the milliseconds component of this log event's timestamp
- See Also:
-
getInstant
Description copied from interface:LogEventReturns the Instant when the message was logged.Caution: if this
LogEventimplementation is mutable and reused for multiple consecutive log messages, then theInstantobject returned by this method is also mutable and reused. Client code should not keep a reference to the returned object but make a copy instead.- Specified by:
getInstantin interfaceLogEvent- Returns:
- the
Instantholding Instant details for this log event
-
isEndOfBatch
public abstract boolean isEndOfBatch()Description copied from interface:LogEventReturnstrueif this event is the last one in a batch,falseotherwise. Used by asynchronous Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient alternative to theimmediateFlush=trueconfiguration.- Specified by:
isEndOfBatchin interfaceLogEvent- Returns:
- whether this event is the last one in a batch.
-
isIncludeLocation
public abstract boolean isIncludeLocation()Description copied from interface:LogEventReturns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take aStackTracesnapshot or not before handing off this event to another thread.- Specified by:
isIncludeLocationin interfaceLogEvent- Returns:
trueif the source of the logging request is required downstream,falseotherwise.- See Also:
-
setEndOfBatch
public abstract void setEndOfBatch(boolean endOfBatch) Description copied from interface:LogEventSets whether this event is the last one in a batch. Used by asynchronous Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient alternative to theimmediateFlush=trueconfiguration.- Specified by:
setEndOfBatchin interfaceLogEvent- Parameters:
endOfBatch-trueif this event is the last one in a batch,falseotherwise.
-
setIncludeLocation
public abstract void setIncludeLocation(boolean locationRequired) Description copied from interface:LogEventSets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take aStackTracesnapshot or not before handing off this event to another thread.- Specified by:
setIncludeLocationin interfaceLogEvent- Parameters:
locationRequired-trueif the source of the logging request is required downstream,falseotherwise.- See Also:
-