Logback Classic Module 1.5.1 · ch.qos.logback.classic.spi.LoggingEvent

Modifier and Type	Field and Description
private transient Object[]	argumentArray
private StackTraceElement[]	callerDataArray
pack-priv transient String	formattedMessage
pack-priv transient String	fqnOfLoggerClass Fully qualified name of the calling Logger class.
private Instant	instant The number of milliseconds elapsed from 1/1/1970 until logging event was created.
pack-priv List<KeyValuePair>	keyValuePairs
private transient Level	level Level of logging event.
private LoggerContext	loggerContext
private LoggerContextVO	loggerContextVO
private String	loggerName
private List<Marker>	markerList
private Map<String, String>	mdcPropertyMap
private String	message
private int	nanoseconds
public static final String	REGULAR_UNNAMED_THREAD_PREFIX
private long	sequenceNumber
private String	threadName The name of thread in which this logging event was generated.
private ThrowableProxy	throwableProxy
private long	timeStamp
public static final String	VIRTUAL_THREAD_NAME_PREFIX

Access	Constructor and Description
public	LoggingEvent()
public	LoggingEvent(String fqcn, Logger logger, Level level, String message, Throwable throwable, Object[] argArray)

Method Summary

Modifier and Type	Method and Description
public void	addKeyValuePair(KeyValuePair kvp)
public void	addMarker(Marker marker)
private String	extractThreadName(Thread aThread) Extracts the name of aThread by calling `Thread#getName()`.
private Throwable	extractThrowableAnRearrangeArguments(Object[] argArray)
public Object[]	getArgumentArray() Implements ch.qos.logback.classic.spi.ILoggingEvent.getArgumentArray.
public StackTraceElement[]	getCallerData() Implements ch.qos.logback.classic.spi.ILoggingEvent.getCallerData. Get the caller information for this logging event.
public long	getContextBirthTime()
public String	getFormattedMessage() Implements ch.qos.logback.classic.spi.ILoggingEvent.getFormattedMessage.
public Instant	getInstant() Overrides default ch.qos.logback.classic.spi.ILoggingEvent.getInstant. Return the `Instant` corresponding to the creation of this event.
public List<KeyValuePair>	getKeyValuePairs() Implements ch.qos.logback.classic.spi.ILoggingEvent.getKeyValuePairs. A list of `KeyValuePair` objects.
public Level	getLevel() Implements ch.qos.logback.classic.spi.ILoggingEvent.getLevel.
public LoggerContextVO	getLoggerContextVO() Implements ch.qos.logback.classic.spi.ILoggingEvent.getLoggerContextVO.
public String	getLoggerName() Implements ch.qos.logback.classic.spi.ILoggingEvent.getLoggerName.
public List<Marker>	getMarkerList() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMarkerList. Since SLF4J 2.0.0, the slf4j logging API assumes the possibility of multiple Marker instances in a logging event.
public Map<String, String>	getMdc() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMdc. Deprecated Replaced by [@link #getMDCPropertyMap} Synonym for [@link #getMDCPropertyMap}.
public Map<String, String>	getMDCPropertyMap() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMDCPropertyMap. Returns the MDC map.
public String	getMessage() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMessage.
public int	getNanoseconds() Implements ch.qos.logback.classic.spi.ILoggingEvent.getNanoseconds. Return the number of nanoseconds past the `timestamp in seconds`.
public long	getSequenceNumber() Implements ch.qos.logback.classic.spi.ILoggingEvent.getSequenceNumber. The sequence number associated with this event.
public String	getThreadName() Implements ch.qos.logback.classic.spi.ILoggingEvent.getThreadName.
public IThrowableProxy	getThrowableProxy() Implements ch.qos.logback.classic.spi.ILoggingEvent.getThrowableProxy. Returns the throwable information contained within this event.
public long	getTimeStamp() Implements ch.qos.logback.classic.spi.ILoggingEvent.getTimeStamp. Return the number of elapsed milliseconds since epoch in UTC.
pack-priv Long	Returns: Return the threadId if the thread is a virtual thread, return null otherwise. getVirtualThreadId(Thread aThread) Return the threadId if running under JDK 21+ and the thread is a virtual thread, return null otherwise.
public boolean	hasCallerData() Implements ch.qos.logback.classic.spi.ILoggingEvent.hasCallerData. If this event has caller data, then true is returned.
pack-priv void	initTmestampFields(Instant instant)
public void	prepareForDeferredProcessing() Implements ch.qos.logback.classic.spi.ILoggingEvent.prepareForDeferredProcessing. This method should be called prior to serializing an event.
public void	setArgumentArray(Object[] argArray)
public void	setCallerData(StackTraceElement[] callerDataArray)
public void	setInstant(Instant instant) Set `Instant` corresponding to the creation of this event.
public void	setKeyValuePairs(List<KeyValuePair> kvpList)
public void	setLevel(Level level)
public void	setLoggerContext(LoggerContext lc)
public void	setLoggerContextRemoteView(LoggerContextVO loggerContextVO)
public void	setLoggerName(String loggerName)
public void	setMDCPropertyMap(Map<String, String> map) Set the MDC map for this event.
public void	setMessage(String message)
public void	setSequenceNumber(long sn)
public void	setThreadName(String The threadName to set. threadName)
public void	setThrowableProxy(ThrowableProxy tp) Set this event's throwable information.
public void	setTimeStamp(long timeStamp) Set the number of elapsed milliseconds since epoch in UTC.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	writeObject(ObjectOutputStream out) LoggerEventVO instances should be used for serialization.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

argumentArray	back to summary
private transient Object[] argumentArray

callerDataArray	back to summary
private StackTraceElement[] callerDataArray

formattedMessage	back to summary
pack-priv transient String formattedMessage

fqnOfLoggerClass	back to summary
pack-priv transient String fqnOfLoggerClass Fully qualified name of the calling Logger class. This field does not survive serialization. Note that the getCallerInformation() method relies on this fact.

instant	back to summary
private Instant instant The number of milliseconds elapsed from 1/1/1970 until logging event was created.

keyValuePairs	back to summary
pack-priv List<KeyValuePair> keyValuePairs Since 1.3.0

level	back to summary
private transient Level level Level of logging event. This field should not be accessed directly. You should use the `getLevel` method instead.

loggerContext	back to summary
private LoggerContext loggerContext

loggerContextVO	back to summary
private LoggerContextVO loggerContextVO

loggerName	back to summary
private String loggerName

markerList	back to summary
private List<Marker> markerList

mdcPropertyMap	back to summary
private Map<String, String> mdcPropertyMap

message	back to summary
private String message

nanoseconds	back to summary
private int nanoseconds

REGULAR_UNNAMED_THREAD_PREFIX	back to summary
public static final String REGULAR_UNNAMED_THREAD_PREFIX

sequenceNumber	back to summary
private long sequenceNumber

threadName	back to summary
private String threadName The name of thread in which this logging event was generated.

throwableProxy	back to summary
private ThrowableProxy throwableProxy

timeStamp	back to summary
private long timeStamp

VIRTUAL_THREAD_NAME_PREFIX	back to summary
public static final String VIRTUAL_THREAD_NAME_PREFIX

LoggingEvent	back to summary
public LoggingEvent()

LoggingEvent	back to summary
public LoggingEvent(String fqcn, Logger logger, Level level, String message, Throwable throwable, Object[] argArray)

Method Detail

addKeyValuePair	back to summary
public void addKeyValuePair(KeyValuePair kvp)

addMarker	back to summary
public void addMarker(Marker marker)

extractThreadName back to summary

extractThreadName	back to summary
private String extractThreadName(Thread aThread) Extracts the name of aThread by calling `Thread#getName()`. If the value is null, then use the value returned by `Thread#getId()` prefixing with `VIRTUAL_THREAD_NAME_PREFIX` if thread is virtual or with `REGULAR_UNNAMED_THREAD_PREFIX` if regular. Since 1.5.0

private String extractThreadName(Thread aThread)

Extracts the name of aThread by calling Thread#getName(). If the value is null, then use the value returned by Thread#getId() prefixing with VIRTUAL_THREAD_NAME_PREFIX if thread is virtual or with REGULAR_UNNAMED_THREAD_PREFIX if regular.

Since: 1.5.0

extractThrowableAnRearrangeArguments	back to summary
private Throwable extractThrowableAnRearrangeArguments(Object[] argArray)

getArgumentArray	back to summary
public Object[] getArgumentArray() Implements ch.qos.logback.classic.spi.ILoggingEvent.getArgumentArray.

getCallerData	back to summary
public StackTraceElement[] getCallerData() Implements ch.qos.logback.classic.spi.ILoggingEvent.getCallerData. Get the caller information for this logging event. If caller information is null at the time of its invocation, this method extracts location information. The collected information is cached for future use. Note that after serialization it is impossible to correctly extract caller information. Returns:StackTraceElement[] Doc from ch.qos.logback.classic.spi.ILoggingEvent.getCallerData. the caller data associated with this event.

getCallerData

back to summary

public StackTraceElement[] getCallerData()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getCallerData.

Get the caller information for this logging event. If caller information is null at the time of its invocation, this method extracts location information. The collected information is cached for future use.

Note that after serialization it is impossible to correctly extract caller information.

Returns:StackTraceElement[]

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getCallerData.

the caller data associated with this event.

getContextBirthTime	back to summary
public long getContextBirthTime()

getFormattedMessage	back to summary
public String getFormattedMessage() Implements ch.qos.logback.classic.spi.ILoggingEvent.getFormattedMessage.

getInstant back to summary

getInstant	back to summary
public Instant getInstant() Overrides default ch.qos.logback.classic.spi.ILoggingEvent.getInstant. Return the `Instant` corresponding to the creation of this event. Returns:Instant Doc from ch.qos.logback.classic.spi.ILoggingEvent.getInstant. the `Instant` the event was created. Since 1.3 See Also `getTimeStamp()`

public Instant getInstant()

Overrides default ch.qos.logback.classic.spi.ILoggingEvent.getInstant.

Return the Instant corresponding to the creation of this event.

Returns:Instant

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getInstant.

the Instant the event was created.

Since

1.3

See Also

getTimeStamp()

getKeyValuePairs back to summary

getKeyValuePairs	back to summary
public List<KeyValuePair> getKeyValuePairs() Implements ch.qos.logback.classic.spi.ILoggingEvent.getKeyValuePairs. Doc from ch.qos.logback.classic.spi.ILoggingEvent.getKeyValuePairs. A list of `KeyValuePair` objects. The returned list may be null. Returns:List<KeyValuePair> may be null Annotations @Override

public List<KeyValuePair> getKeyValuePairs()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getKeyValuePairs.

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getKeyValuePairs.

A list of KeyValuePair objects. The returned list may be null.

Returns:List<KeyValuePair>

may be null

Annotations

@Override

getLevel	back to summary
public Level getLevel() Implements ch.qos.logback.classic.spi.ILoggingEvent.getLevel.

getLoggerContextVO	back to summary
public LoggerContextVO getLoggerContextVO() Implements ch.qos.logback.classic.spi.ILoggingEvent.getLoggerContextVO.

getLoggerName	back to summary
public String getLoggerName() Implements ch.qos.logback.classic.spi.ILoggingEvent.getLoggerName.

getMarkerList	back to summary
public List<Marker> getMarkerList() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMarkerList. Doc from ch.qos.logback.classic.spi.ILoggingEvent.getMarkerList. Since SLF4J 2.0.0, the slf4j logging API assumes the possibility of multiple Marker instances in a logging event. Consequently, ILoggingEvent needs to cater for this possibility. Returns:List<Marker> the marker list, may be null

getMarkerList

back to summary

public List<Marker> getMarkerList()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getMarkerList.

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getMarkerList.

Since SLF4J 2.0.0, the slf4j logging API assumes the possibility of multiple Marker instances in a logging event. Consequently, ILoggingEvent needs to cater for this possibility.

Returns:List<Marker>: the marker list, may be null

getMdc	back to summary
public Map<String, String> getMdc() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMdc. Deprecated Replaced by [@link #getMDCPropertyMap} Synonym for [@link #getMDCPropertyMap}.

getMdc

back to summary

public Map<String, String> getMdc()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getMdc.

Deprecated

Replaced by [@link #getMDCPropertyMap}

Synonym for [@link #getMDCPropertyMap}.

getMDCPropertyMap	back to summary
public Map<String, String> getMDCPropertyMap() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMDCPropertyMap. Doc from ch.qos.logback.classic.spi.ILoggingEvent.getMDCPropertyMap. Returns the MDC map. The returned value can be an empty map but not null.

getMDCPropertyMap

back to summary

public Map<String, String> getMDCPropertyMap()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getMDCPropertyMap.

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getMDCPropertyMap.

Returns the MDC map. The returned value can be an empty map but not null.

getMessage	back to summary
public String getMessage() Implements ch.qos.logback.classic.spi.ILoggingEvent.getMessage.

getNanoseconds back to summary

getNanoseconds	back to summary
public int getNanoseconds() Implements ch.qos.logback.classic.spi.ILoggingEvent.getNanoseconds. Return the number of nanoseconds past the `timestamp in seconds`. Returns:int Doc from ch.qos.logback.classic.spi.ILoggingEvent.getNanoseconds. the number of elapsed nanoseconds as found in `getInstant()` Annotations @Override Since 1.3.0

public int getNanoseconds()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getNanoseconds.

Return the number of nanoseconds past the timestamp in seconds.

Returns:int

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getNanoseconds.

the number of elapsed nanoseconds as found in getInstant()

Annotations

@Override

Since

1.3.0

getSequenceNumber	back to summary
public long getSequenceNumber() Implements ch.qos.logback.classic.spi.ILoggingEvent.getSequenceNumber. Doc from ch.qos.logback.classic.spi.ILoggingEvent.getSequenceNumber. The sequence number associated with this event. Sequence numbers, if present, should be increasing monotonically. Annotations @Override

getSequenceNumber

back to summary

public long getSequenceNumber()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getSequenceNumber.

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getSequenceNumber.

The sequence number associated with this event.

Sequence numbers, if present, should be increasing monotonically.

Annotations

@Override

getThreadName	back to summary
public String getThreadName() Implements ch.qos.logback.classic.spi.ILoggingEvent.getThreadName.

getThrowableProxy back to summary

getThrowableProxy	back to summary
public IThrowableProxy getThrowableProxy() Implements ch.qos.logback.classic.spi.ILoggingEvent.getThrowableProxy. Returns the throwable information contained within this event. May be `null` if there is no such information.

public IThrowableProxy getThrowableProxy()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getThrowableProxy.

Returns the throwable information contained within this event. May be null if there is no such information.

getTimeStamp	back to summary
public long getTimeStamp() Implements ch.qos.logback.classic.spi.ILoggingEvent.getTimeStamp. Return the number of elapsed milliseconds since epoch in UTC. Returns:long Doc from ch.qos.logback.classic.spi.ILoggingEvent.getTimeStamp. the number of elapsed milliseconds since epoch

getTimeStamp

back to summary

public long getTimeStamp()

Implements ch.qos.logback.classic.spi.ILoggingEvent.getTimeStamp.

Return the number of elapsed milliseconds since epoch in UTC.

Returns:long

Doc from ch.qos.logback.classic.spi.ILoggingEvent.getTimeStamp.

the number of elapsed milliseconds since epoch

getVirtualThreadId	back to summary
pack-priv Long getVirtualThreadId(Thread aThread) Return the threadId if running under JDK 21+ and the thread is a virtual thread, return null otherwise. Returns:Long Return the threadId if the thread is a virtual thread, return null otherwise.

getVirtualThreadId

back to summary

pack-priv Long getVirtualThreadId(Thread aThread)

Return the threadId if running under JDK 21+ and the thread is a virtual thread, return null otherwise.

Returns:Long: Return the threadId if the thread is a virtual thread, return null otherwise.

hasCallerData back to summary

hasCallerData	back to summary
public boolean hasCallerData() Implements ch.qos.logback.classic.spi.ILoggingEvent.hasCallerData. Doc from ch.qos.logback.classic.spi.ILoggingEvent.hasCallerData. If this event has caller data, then true is returned. Otherwise the returned value is null. Logback components wishing to use caller data if available without causing it to be computed can invoke this method before invoking `getCallerData()`. Returns:boolean whether this event has caller data

public boolean hasCallerData()

Implements ch.qos.logback.classic.spi.ILoggingEvent.hasCallerData.

Doc from ch.qos.logback.classic.spi.ILoggingEvent.hasCallerData.

If this event has caller data, then true is returned. Otherwise the returned value is null.

Logback components wishing to use caller data if available without causing it to be computed can invoke this method before invoking getCallerData().

Returns:boolean: whether this event has caller data

initTmestampFields	back to summary
pack-priv void initTmestampFields(Instant instant)

prepareForDeferredProcessing

back to summary

public void prepareForDeferredProcessing()

Implements ch.qos.logback.classic.spi.ILoggingEvent.prepareForDeferredProcessing.

This method should be called prior to serializing an event. It should also be called when using asynchronous or deferred logging.

Note that due to performance concerns, this method does NOT extract caller data. It is the responsibility of the caller to extract caller information.

setArgumentArray	back to summary
public void setArgumentArray(Object[] argArray)

setCallerData	back to summary
public void setCallerData(StackTraceElement[] callerDataArray)

setInstant	back to summary
public void setInstant(Instant instant) Set `Instant` corresponding to the creation of this event. The value of `getTimeStamp()` will be overridden as well.

setKeyValuePairs	back to summary
public void setKeyValuePairs(List<KeyValuePair> kvpList)

setLevel	back to summary
public void setLevel(Level level)

setLoggerContext	back to summary
public void setLoggerContext(LoggerContext lc)

setLoggerContextRemoteView	back to summary
public void setLoggerContextRemoteView(LoggerContextVO loggerContextVO)

setLoggerName	back to summary
public void setLoggerName(String loggerName)

setMDCPropertyMap

back to summary

public void setMDCPropertyMap(Map<String, String> map)

Set the MDC map for this event.

Since: 1.0.8

setMessage	back to summary
public void setMessage(String message)

setSequenceNumber	back to summary
public void setSequenceNumber(long sn)

setThreadName	back to summary
public void setThreadName(String threadName) throws IllegalStateException Parameters threadName:String The threadName to set. Exceptions IllegalStateException: If threadName has been already set.

setThrowableProxy	back to summary
public void setThrowableProxy(ThrowableProxy tp) Set this event's throwable information.

setTimeStamp	back to summary
public void setTimeStamp(long timeStamp) Set the number of elapsed milliseconds since epoch in UTC. Setting the timestamp will override the value contained in `getInstant`. Nanoseconds value will be computed form the provided millisecond value.