Package org.apache.logging.log4j.core.async

Class RingBufferLogEvent

java.lang.Object

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

All Implemented Interfaces:

Serializable, CharSequence, LogEvent, Message, ParameterVisitable, ReusableMessage, StringBuilderFormattable

public class RingBufferLogEvent
extends Object
implements LogEvent, ReusableMessage, CharSequence, ParameterVisitable

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

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.logging.log4j.core.async.RingBufferLogEvent.Factory	FACTORY	The EventFactory for RingBufferLogEvents.

Constructor Summary

Constructors

Constructor	Description
RingBufferLogEvent()

Method Summary

Modifier and Type	Method	Description
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.
<S> void	forEachParameter(ParameterConsumer<S> action, S state)
void	formatTo(StringBuilder buffer)
ReadOnlyStringMap	getContextData()	Returns the ReadOnlyStringMap object holding context data key-value pairs.
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).
String	getFormat()
String	getFormattedMessage()
Instant	getInstant()	Returns the Instant when the message was logged.
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.
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.
short	getParameterCount()
Object[]	getParameters()
StackTraceElement	getSource()	Gets the source of logging request.
long	getThreadId()	Gets the thread ID.
String	getThreadName()	Gets the thread name.
int	getThreadPriority()	Gets the thread priority.
Throwable	getThrowable()
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.
boolean	isPopulated()
int	length()
Message	memento()
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.
void	setValues(AsyncLogger anAsyncLogger, String aLoggerName, Marker aMarker, String theFqcn, Level aLevel, Message msg, Throwable aThrowable, StringMap mutableContextData, ThreadContext.ContextStack aContextStack, long threadId, String threadName, int threadPriority, StackTraceElement aLocation, Clock clock, NanoClock nanoClock)
CharSequence	subSequence(int start, int end)
Object[]	swapParameters(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.

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 org.apache.logging.log4j.core.async.RingBufferLogEvent.Factory FACTORY

The EventFactory for RingBufferLogEvents.

Constructor Detail

RingBufferLogEvent

public RingBufferLogEvent()

Method Detail

setValues

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

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

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

isPopulated

public boolean isPopulated()

Returns:

true if this event is populated with data, false otherwise

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 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 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 String getFormattedMessage()

Specified by:

getFormattedMessage in interface Message

See Also:

Message.getFormattedMessage()

getFormat

public String getFormat()

Specified by:

getFormat in interface Message

See Also:

Message.getFormat()

getParameters

public Object[] getParameters()

Specified by:

getParameters in interface Message

See Also:

Message.getParameters()

getThrowable

public Throwable getThrowable()

Specified by:

getThrowable in interface Message

See Also:

Message.getThrowable()

formatTo

public void formatTo(StringBuilder buffer)

Specified by:

formatTo in interface StringBuilderFormattable

See Also:

StringBuilderFormattable.formatTo(StringBuilder)

swapParameters

public Object[] swapParameters(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()

Specified by:

getParameterCount in interface ReusableMessage

forEachParameter

public <S> void forEachParameter(ParameterConsumer<S> action,
                                 S state)

Specified by:

forEachParameter in interface ParameterVisitable

memento

public Message memento()

Specified by:

memento in interface ReusableMessage

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

getThrown

public 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

getContextMap

public Map<String,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 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 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. Use LogEvent.getInstant() to get higher precision timestamp information if available on this platform.

Specified by:

getTimeMillis in interface LogEvent

Returns:

the milliseconds component of this log event's timestamp

See Also:

System.currentTimeMillis()

getInstant

public Instant getInstant()

Description copied from interface: LogEvent

Returns the Instant when the message was logged.

Caution: if this LogEvent implementation is mutable and reused for multiple consecutive log messages, then the Instant object 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:

getInstant in interface LogEvent

Returns:

the Instant holding Instant details for this log event

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.

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