org.apache.logging.log4j.core.async

Class RingBufferLogEvent

java.lang.Object

org.apache.logging.log4j.core.async.RingBufferLogEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, LogEvent, Message, ReusableMessage, StringBuilderFormattable

public class RingBufferLogEvent
extends java.lang.Object
implements LogEvent, ReusableMessage, java.lang.CharSequence

When the Disruptor is started, the RingBuffer is populated with event objects. These objects are then re-used during the life of the RingBuffer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RingBufferLogEvent.Factory Creates the events that will be put in the RingBuffer.

Field Summary

Fields

Modifier and Type	Field and Description
private AsyncLogger	asyncLogger
private StringMap	contextData
private ThreadContext.ContextStack	contextStack
private long	currentTimeMillis
private static Message	EMPTY
private boolean	endOfBatch
static RingBufferLogEvent.Factory	FACTORY The EventFactory for RingBufferLogEvents.
private java.lang.String	fqcn
private boolean	includeLocation
private Level	level
private java.lang.StackTraceElement	location
private java.lang.String	loggerName
private Marker	marker
private Message	message
private java.lang.StringBuilder	messageText
private long	nanoTime
private short	parameterCount
private java.lang.Object[]	parameters
private static long	serialVersionUID
private long	threadId
private java.lang.String	threadName
private int	threadPriority
private java.lang.Throwable	thrown
private ThrowableProxy	thrownProxy

Constructor Summary

Constructors

Constructor and Description
RingBufferLogEvent()

Method Summary

Modifier and Type	Method and Description
private boolean	canFormatMessageInBackground(Message message)
char	charAt(int index)
void	clear() Release references held by ring buffer to allow objects to be garbage-collected.
LogEvent	createMemento() Creates and returns a new immutable copy of this RingBufferLogEvent.
void	execute(boolean endOfBatch) Event processor that reads the event from the ringbuffer can call this method.
void	formatTo(java.lang.StringBuilder buffer) Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
ReadOnlyStringMap	getContextData() Returns the ReadOnlyStringMap object holding context data key-value pairs.
java.util.Map<java.lang.String,java.lang.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).
java.lang.String	getFormat() Gets the format portion of the Message.
java.lang.String	getFormattedMessage() Gets the Message formatted as a String.
Level	getLevel() Gets the level.
java.lang.String	getLoggerFqcn() Returns the fully qualified class name of the caller of the logging API.
java.lang.String	getLoggerName() Gets the logger name.
Marker	getMarker() Gets the Marker associated with the event.
Message	getMessage() Gets the message associated with the event.
private java.lang.StringBuilder	getMessageTextForWriting()
long	getNanoTime() Returns 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.
private Message	getNonNullImmutableMessage()
short	getParameterCount() Returns the number of parameters that was used to initialize this reusable message for the current content.
java.lang.Object[]	getParameters() Gets parameter values, if any.
java.lang.StackTraceElement	getSource() Gets the source of logging request.
long	getThreadId() Gets the thread ID.
java.lang.String	getThreadName() Gets the thread name.
int	getThreadPriority() Gets the thread priority.
java.lang.Throwable	getThrowable() Gets the throwable, if any.
java.lang.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.
void	initializeBuilder(Log4jLogEvent.Builder builder) Initializes the specified Log4jLogEvent.Builder from this RingBufferLogEvent.
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.
int	length()
Message	memento() Returns an immutable snapshot of the current internal state of this reusable message.
(package private) void	setContextData(StringMap contextData)
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.
private void	setMessage(Message msg)
void	setValues(AsyncLogger anAsyncLogger, java.lang.String aLoggerName, Marker aMarker, java.lang.String theFqcn, Level aLevel, Message msg, java.lang.Throwable aThrowable, StringMap mutableContextData, ThreadContext.ContextStack aContextStack, long threadId, java.lang.String threadName, int threadPriority, java.lang.StackTraceElement aLocation, long aCurrentTimeMillis, long aNanoTime)
java.lang.CharSequence	subSequence(int start, int end)
java.lang.Object[]	swapParameters(java.lang.Object[] emptyReplacement) Replaces this ReusableMessage's parameter array with the specified value and return the original array
LogEvent	toImmutable() Returns an immutable version of this log event, which MAY BE a copy of this event.
private void	trimMessageText()
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Field Detail

FACTORY

public static final RingBufferLogEvent.Factory FACTORY

The EventFactory for RingBufferLogEvents.

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

EMPTY

private static final Message EMPTY

threadPriority

private int threadPriority

threadId

private long threadId

currentTimeMillis

private long currentTimeMillis

nanoTime

private long nanoTime

parameterCount

private short parameterCount

includeLocation

private boolean includeLocation

endOfBatch

private boolean endOfBatch

level

private Level level

threadName

private java.lang.String threadName

loggerName

private java.lang.String loggerName

message

private Message message

messageText

private java.lang.StringBuilder messageText

parameters

private java.lang.Object[] parameters

thrown

private transient java.lang.Throwable thrown

thrownProxy

private ThrowableProxy thrownProxy

contextData

private StringMap contextData

marker

private Marker marker

fqcn

private java.lang.String fqcn

location

private java.lang.StackTraceElement location

contextStack

private ThreadContext.ContextStack contextStack

asyncLogger

private transient AsyncLogger asyncLogger

Constructor Detail

RingBufferLogEvent

public RingBufferLogEvent()

Method Detail

setValues

public void setValues(AsyncLogger anAsyncLogger,
                      java.lang.String aLoggerName,
                      Marker aMarker,
                      java.lang.String theFqcn,
                      Level aLevel,
                      Message msg,
                      java.lang.Throwable aThrowable,
                      StringMap mutableContextData,
                      ThreadContext.ContextStack aContextStack,
                      long threadId,
                      java.lang.String threadName,
                      int threadPriority,
                      java.lang.StackTraceElement aLocation,
                      long aCurrentTimeMillis,
                      long aNanoTime)

toImmutable

public LogEvent toImmutable()

Description copied from interface: LogEvent

Returns an immutable version of this log event, which MAY BE a copy of this event.

Specified by:

toImmutable in interface LogEvent

Returns:

an immutable version of this log event

setMessage

private void setMessage(Message msg)

canFormatMessageInBackground

private boolean canFormatMessageInBackground(Message message)

getMessageTextForWriting

private java.lang.StringBuilder getMessageTextForWriting()

execute

public void execute(boolean endOfBatch)

Event processor that reads the event from the ringbuffer can call this method.

Parameters:

endOfBatch - flag to indicate if this is the last event in a batch from the RingBuffer

isEndOfBatch

public boolean isEndOfBatch()

Returns true if this event is the end of a batch, false otherwise.

Specified by:

isEndOfBatch in interface LogEvent

Returns:

true if this event is the end of a batch, false otherwise

setEndOfBatch

public void setEndOfBatch(boolean endOfBatch)

Description copied from interface: LogEvent

Sets 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 the immediateFlush=true configuration.

Specified by:

setEndOfBatch in interface LogEvent

Parameters:

endOfBatch - true if this event is the last one in a batch, false otherwise.

isIncludeLocation

public boolean isIncludeLocation()

Description copied from interface: LogEvent

Returns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take a StackTrace snapshot or not before handing off this event to another thread.

Specified by:

isIncludeLocation in interface LogEvent

Returns:

true if the source of the logging request is required downstream, false otherwise.

See Also:

LogEvent.getSource()

setIncludeLocation

public void setIncludeLocation(boolean includeLocation)

Description copied from interface: LogEvent

Sets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take a StackTrace snapshot or not before handing off this event to another thread.

Specified by:

setIncludeLocation in interface LogEvent

Parameters:

includeLocation - true if the source of the logging request is required downstream, false otherwise.

See Also:

LogEvent.getSource()

getLoggerName

public java.lang.String getLoggerName()

Description copied from interface: LogEvent

Gets the logger name.

Specified by:

getLoggerName in interface LogEvent

Returns:

logger name, may be null.

getMarker

public Marker getMarker()

Description copied from interface: LogEvent

Gets the Marker associated with the event.

Specified by:

getMarker in interface LogEvent

Returns:

Marker or null if no Marker was defined on this LogEvent

getLoggerFqcn

public java.lang.String getLoggerFqcn()

Description copied from interface: LogEvent

Returns the fully qualified class name of the caller of the logging API.

Specified by:

getLoggerFqcn in interface LogEvent

Returns:

The fully qualified class name of the caller.

getLevel

public Level getLevel()

Description copied from interface: LogEvent

Gets the level.

Specified by:

getLevel in interface LogEvent

Returns:

level.

getMessage

public Message getMessage()

Description copied from interface: LogEvent

Gets the message associated with the event.

Specified by:

getMessage in interface LogEvent

Returns:

message.

getFormattedMessage

public java.lang.String getFormattedMessage()

Description copied from interface: Message

Gets 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 ReusableMessage or is annotated with AsynchronouslyFormattable. 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 StringBuilderFormattable interface: instead, the formatTo(StringBuilder) method will be called so the Message can format its contents without creating intermediate String objects.

Specified by:

getFormattedMessage in interface Message

Returns:

The message String.

See Also:

Message.getFormattedMessage()

getFormat

public java.lang.String getFormat()

Description copied from interface: Message

Gets the format portion of the Message.

Specified by:

getFormat in interface Message

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:

Message.getFormat()

getParameters

public java.lang.Object[] getParameters()

Description copied from interface: Message

Gets parameter values, if any.

Specified by:

getParameters in interface Message

Returns:

An array of parameter values or null.

See Also:

Message.getParameters()

getThrowable

public java.lang.Throwable getThrowable()

Description copied from interface: Message

Gets the throwable, if any.

Specified by:

getThrowable in interface Message

Returns:

the throwable or null.

See Also:

Message.getThrowable()

formatTo

public void formatTo(java.lang.StringBuilder buffer)

Description copied from interface: StringBuilderFormattable

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Specified by:

formatTo in interface StringBuilderFormattable

Parameters:

buffer - the StringBuilder to write into

See Also:

StringBuilderFormattable.formatTo(StringBuilder)

swapParameters

public java.lang.Object[] swapParameters(java.lang.Object[] emptyReplacement)

Replaces this ReusableMessage's parameter array with the specified value and return the original array

Specified by:

swapParameters in interface ReusableMessage

Parameters:

emptyReplacement - the parameter array that can be used for subsequent uses of this reusable message

Returns:

the original parameter array

See Also:

ReusableMessage.swapParameters(Object[])

getParameterCount

public short getParameterCount()

Description copied from interface: ReusableMessage

Returns 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:

getParameterCount in interface ReusableMessage

Returns:

the current number of parameters

memento

public Message memento()

Description copied from interface: ReusableMessage

Returns 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:

memento in interface ReusableMessage

Returns:

an immutable snapshot of this message

length

public int length()

Specified by:

length in interface java.lang.CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

getNonNullImmutableMessage

private Message getNonNullImmutableMessage()

getThrown

public java.lang.Throwable getThrown()

Description copied from interface: LogEvent

Gets throwable associated with logging request.

Convenience method for ThrowableProxy.getThrowable();

Specified by:

getThrown in interface LogEvent

Returns:

throwable, may be null.

getThrownProxy

public ThrowableProxy getThrownProxy()

Description copied from interface: LogEvent

Gets throwable proxy associated with logging request.

Specified by:

getThrownProxy in interface LogEvent

Returns:

throwable, may be null.

getContextData

public ReadOnlyStringMap getContextData()

Description copied from interface: LogEvent

Returns the ReadOnlyStringMap object 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 custom ContextDataInjector to inject key-value pairs from any arbitrary source.

Specified by:

getContextData in interface LogEvent

Returns:

the ReadOnlyStringMap object holding context data key-value pairs

See Also:

ContextDataInjector, ThreadContext

setContextData

void setContextData(StringMap contextData)

getContextMap

public java.util.Map<java.lang.String,java.lang.String> getContextMap()

Description copied from interface: LogEvent

Gets the context map (also know as Mapped Diagnostic Context or MDC).

Specified by:

getContextMap in interface LogEvent

Returns:

The context map, never null.

getContextStack

public ThreadContext.ContextStack getContextStack()

Description copied from interface: LogEvent

Gets the context stack (also known as Nested Diagnostic Context or NDC).

Specified by:

getContextStack in interface LogEvent

Returns:

The context stack, never null.

getThreadId

public long getThreadId()

Description copied from interface: LogEvent

Gets the thread ID.

Specified by:

getThreadId in interface LogEvent

Returns:

thread ID.

getThreadName

public java.lang.String getThreadName()

Description copied from interface: LogEvent

Gets the thread name.

Specified by:

getThreadName in interface LogEvent

Returns:

thread name, may be null. TODO guess this could go into a thread context object too. (RG) Why?

getThreadPriority

public int getThreadPriority()

Description copied from interface: LogEvent

Gets the thread priority.

Specified by:

getThreadPriority in interface LogEvent

Returns:

thread priority.

getSource

public java.lang.StackTraceElement getSource()

Description copied from interface: LogEvent

Gets the source of logging request.

Specified by:

getSource in interface LogEvent

Returns:

source of logging request, may be null.

getTimeMillis

public long getTimeMillis()

Description copied from interface: LogEvent

Gets event time in milliseconds since midnight, January 1, 1970 UTC.

Specified by:

getTimeMillis in interface LogEvent

Returns:

milliseconds since midnight, January 1, 1970 UTC.

See Also:

System.currentTimeMillis()

getNanoTime

public long getNanoTime()

Description copied from interface: LogEvent

Returns 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:

getNanoTime in interface LogEvent

Returns:

The value of the running Java Virtual Machine's high-resolution time source when this event was created.

clear

public void clear()

Release references held by ring buffer to allow objects to be garbage-collected.

trimMessageText

private void trimMessageText()

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

createMemento

public LogEvent createMemento()

Creates and returns a new immutable copy of this RingBufferLogEvent.

Returns:

a new immutable copy of the data in this RingBufferLogEvent

initializeBuilder

public void initializeBuilder(Log4jLogEvent.Builder builder)

Initializes the specified Log4jLogEvent.Builder from this RingBufferLogEvent.

Parameters:

builder - the builder whose fields to populate