Class MutableLogEvent
- All Implemented Interfaces:
Serializable,LogEvent,Message,ParameterVisitable,ReusableMessage,StringBuilderFormattable
LogEvent interface.- Since:
- 2.6
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringMapprivate ThreadContext.ContextStackprivate static final Messageprivate booleanprivate booleanprivate final MutableInstantprivate Levelprivate Stringprivate Stringprivate Markerprivate Messageprivate Stringprivate StringBuilderprivate longprivate shortprivate Object[](package private) booleanprivate StackTraceElementprivate longprivate Stringprivate intprivate Throwableprivate ThrowableProxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Clears all references this event has to other objects.Creates and returns a new immutable copy of thisMutableLogEvent.<S> voidforEachParameter(ParameterConsumer<S> action, S state) Performs the given action for each parameter until all values have been processed or the action throws an exception.voidformatTo(StringBuilder buffer) Writes a text representation of this object into the specifiedStringBuilder, ideally without allocating temporary objects.Returns theReadOnlyStringMapobject holding context data key-value pairs.Gets the context map (also know as Mapped Diagnostic Context or MDC).Gets the context stack (also known as Nested Diagnostic Context or NDC).Gets the format portion of the Message.Gets the Message formatted as a String.Returns the Instant when the message was logged.getLevel()Gets the level.Returns the fully qualified class name of the caller of the logging API.Gets the logger name.Gets the Marker associated with the event.Gets the message associated with the event.private StringBuilderlongReturns the value of the running Java Virtual Machine's high-resolution time source when this event was created, or a dummy value if it is known that this value will not be used downstream.shortReturns the number of parameters that was used to initialize this reusable message for the current content.Object[]Gets parameter values, if any.Returns the StackTraceElement for the caller.longGets the thread ID.Gets the thread name.intGets the thread priority.Gets the throwable, if any.Gets throwable associated with logging request.Returns the ThrowableProxy associated with the event, or null.longGets event time in milliseconds since midnight, January 1, 1970 UTC.voidInitialize the fields of thisMutableLogEventfrom another event.voidinitializeBuilder(Log4jLogEvent.Builder builder) Initializes the specifiedLog4jLogEvent.Builderfrom thisMutableLogEvent.(package private) voidbooleanReturnstrueif this event is the last one in a batch,falseotherwise.booleanReturns whether the source of the logging request is required downstream.memento()Returns an immutable snapshot of the current internal state of this reusable message.private voidreadObject(ObjectInputStream stream) voidsetContextData(StringMap mutableContextData) voidsetContextStack(ThreadContext.ContextStack contextStack) voidsetEndOfBatch(boolean endOfBatch) Sets whether this event is the last one in a batch.voidsetIncludeLocation(boolean includeLocation) Sets whether the source of the logging request is required downstream.voidvoidsetLoggerFqcn(String loggerFqcn) voidsetLoggerName(String loggerName) voidvoidsetMessage(Message msg) voidsetNanoTime(long nanoTime) voidsetSource(StackTraceElement source) voidsetThreadId(long threadId) voidsetThreadName(String threadName) voidsetThreadPriority(int threadPriority) voidvoidsetTimeMillis(long timeMillis) Object[]swapParameters(Object[] emptyReplacement) Replaces this ReusableMessage's parameter array with the specified value and return the original arrayReturns an immutable version of this log event, which MAY BE a copy of this event.protected ObjectCreates a LogEventProxy that can be serialized.
-
Field Details
-
EMPTY
-
threadPriority
private int threadPriority -
threadId
private long threadId -
instant
-
nanoTime
private long nanoTime -
parameterCount
private short parameterCount -
includeLocation
private boolean includeLocation -
endOfBatch
private boolean endOfBatch -
level
-
threadName
-
loggerName
-
message
-
messageFormat
-
messageText
-
parameters
-
thrown
-
thrownProxy
-
contextData
-
marker
-
loggerFqcn
-
source
-
contextStack
-
reserved
transient boolean reserved
-
-
Constructor Details
-
MutableLogEvent
public MutableLogEvent() -
MutableLogEvent
-
-
Method Details
-
toImmutable
Description copied from interface:LogEventReturns an immutable version of this log event, which MAY BE a copy of this event.- Specified by:
toImmutablein interfaceLogEvent- Returns:
- an immutable version of this log event
-
initFrom
Initialize the fields of thisMutableLogEventfrom another event. Similar in purpose and usage asLog4jLogEvent.LogEventProxy, but a mutable version.This method is used on async logger ringbuffer slots holding MutableLogEvent objects in each slot.
- Parameters:
event- the event to copy data from
-
clear
public void clear()Clears all references this event has to other objects. -
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.
-
setLoggerFqcn
-
getMarker
Description copied from interface:LogEventGets the Marker associated with the event. -
setMarker
-
getLevel
Description copied from interface:LogEventGets the level. -
setLevel
-
getLoggerName
Description copied from interface:LogEventGets the logger name.- Specified by:
getLoggerNamein interfaceLogEvent- Returns:
- logger name, may be
null.
-
setLoggerName
-
getMessage
Description copied from interface:LogEventGets the message associated with the event.- Specified by:
getMessagein interfaceLogEvent- Returns:
- message.
-
setMessage
-
getMessageTextForWriting
-
getFormattedMessage
Description copied from interface:MessageGets the Message formatted as a String. Each Message implementation determines the appropriate way to format the data encapsulated in the Message. Messages that provide more than one way of formatting the Message will implement MultiformatMessage.When configured to log asynchronously, this method is called before the Message is queued, unless this message implements
ReusableMessageor is annotated withAsynchronouslyFormattable. This gives the Message implementation class a chance to create a formatted message String with the current value of any mutable objects. The intention is that the Message implementation caches this formatted message and returns it on subsequent calls. (See LOG4J2-763.)When logging synchronously, this method will not be called for Messages that implement the
StringBuilderFormattableinterface: instead, theformatTo(StringBuilder)method will be called so the Message can format its contents without creating intermediate String objects.- Specified by:
getFormattedMessagein interfaceMessage- Returns:
- The message String.
- See Also:
-
getFormat
Description copied from interface:MessageGets the format portion of the Message.- Specified by:
getFormatin interfaceMessage- Returns:
- The message format. Some implementations, such as ParameterizedMessage, will use this as the message "pattern". Other Messages may simply return an empty String. TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and StructuredDataMessage it is not. It is up to the Message implementer to determine what this method will return. A Formatter is inappropriate as this is very specific to the Message implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.
- See Also:
-
getParameters
Description copied from interface:MessageGets parameter values, if any.- Specified by:
getParametersin interfaceMessage- Returns:
- An array of parameter values or null.
- See Also:
-
forEachParameter
Description copied from interface:ParameterVisitablePerforms the given action for each parameter until all values have been processed or the action throws an exception.The second parameter lets callers pass in a stateful object to be modified with the key-value pairs, so the TriConsumer implementation itself can be stateless and potentially reusable.
- Specified by:
forEachParameterin interfaceParameterVisitable- Type Parameters:
S- type of the third parameter- Parameters:
action- The action to be performed for each key-value pair in this collectionstate- the object to be passed as the third parameter to each invocation on the specified ParameterConsumer.
-
getThrowable
Description copied from interface:MessageGets the throwable, if any.- Specified by:
getThrowablein interfaceMessage- Returns:
- the throwable or null.
- See Also:
-
formatTo
Description copied from interface:StringBuilderFormattableWrites a text representation of this object into the specifiedStringBuilder, ideally without allocating temporary objects.- Specified by:
formatToin interfaceStringBuilderFormattable- Parameters:
buffer- the StringBuilder to write into- See Also:
-
swapParameters
Replaces this ReusableMessage's parameter array with the specified value and return the original array- Specified by:
swapParametersin interfaceReusableMessage- Parameters:
emptyReplacement- the parameter array that can be used for subsequent uses of this reusable message- Returns:
- the original parameter array
- See Also:
-
getParameterCount
public short getParameterCount()Description copied from interface:ReusableMessageReturns the number of parameters that was used to initialize this reusable message for the current content.The parameter array returned by
ReusableMessage.swapParameters(Object[])may be larger than the actual number of parameters. Callers should use this method to determine how many elements the array contains.- Specified by:
getParameterCountin interfaceReusableMessage- Returns:
- the current number of parameters
-
memento
Description copied from interface:ReusableMessageReturns an immutable snapshot of the current internal state of this reusable message. The returned snapshot will not be affected by subsequent modifications of this reusable message.- Specified by:
mementoin interfaceReusableMessage- Returns:
- an immutable snapshot of this message
-
getThrown
Description copied from interface:LogEventGets throwable associated with logging request.Convenience method for
ThrowableProxy.getThrowable(); -
setThrown
-
initTime
-
getTimeMillis
public 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:
-
setTimeMillis
public void setTimeMillis(long timeMillis) -
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
-
getThrownProxy
Returns the ThrowableProxy associated with the event, or null.- Specified by:
getThrownProxyin interfaceLogEvent- Returns:
- The ThrowableProxy associated with the event.
-
setSource
-
getSource
Returns the StackTraceElement for the caller. This will be the entry that occurs right before the first occurrence of FQCN as a class name. -
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:
-
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.
-
setContextData
-
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.
-
setContextStack
-
getThreadId
public long getThreadId()Description copied from interface:LogEventGets the thread ID.- Specified by:
getThreadIdin interfaceLogEvent- Returns:
- thread ID.
-
setThreadId
public void setThreadId(long threadId) -
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?
-
setThreadName
-
getThreadPriority
public int getThreadPriority()Description copied from interface:LogEventGets the thread priority.- Specified by:
getThreadPriorityin interfaceLogEvent- Returns:
- thread priority.
-
setThreadPriority
public void setThreadPriority(int threadPriority) -
isIncludeLocation
public 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:
-
setIncludeLocation
public void setIncludeLocation(boolean includeLocation) 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:
includeLocation-trueif the source of the logging request is required downstream,falseotherwise.- See Also:
-
isEndOfBatch
public 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.
-
setEndOfBatch
public 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.
-
getNanoTime
public long getNanoTime()Description copied from interface:LogEventReturns the value of the running Java Virtual Machine's high-resolution time source when this event was created, or a dummy value if it is known that this value will not be used downstream.- Specified by:
getNanoTimein interfaceLogEvent- Returns:
- The value of the running Java Virtual Machine's high-resolution time source when this event was created.
-
setNanoTime
public void setNanoTime(long nanoTime) -
writeReplace
Creates a LogEventProxy that can be serialized.- Returns:
- a LogEventProxy.
-
readObject
- Throws:
InvalidObjectException
-
createMemento
Creates and returns a new immutable copy of thisMutableLogEvent. IfisIncludeLocation()is true, this will obtain caller location information.- Returns:
- a new immutable copy of the data in this
MutableLogEvent
-
initializeBuilder
Initializes the specifiedLog4jLogEvent.Builderfrom thisMutableLogEvent.- Parameters:
builder- the builder whose fields to populate
-