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

Class RingBufferLogEventTranslator

java.lang.Object

org.apache.logging.log4j.core.async.RingBufferLogEventTranslator

All Implemented Interfaces:

com.lmax.disruptor.EventTranslator<RingBufferLogEvent>

public class RingBufferLogEventTranslator
extends java.lang.Object
implements com.lmax.disruptor.EventTranslator<RingBufferLogEvent>

This class is responsible for writing elements that make up a log event into the ringbuffer RingBufferLogEvent. After this translator populated the ringbuffer event, the disruptor will update the sequence number so that the event can be consumed by another thread.

Usage note: This class is only used on the thread that created it.

Field Summary

Fields

Modifier and Type	Field	Description
private AsyncLogger	asyncLogger
private Clock	clock
private ThreadContext.ContextStack	contextStack
protected java.lang.String	fqcn
private static ContextDataInjector	INJECTOR
protected Level	level
private java.lang.StackTraceElement	location
(package private) java.lang.String	loggerName
protected Marker	marker
protected Message	message
private NanoClock	nanoClock
private long	threadId
private java.lang.String	threadName
private int	threadPriority
protected java.lang.Throwable	thrown

Constructor Summary

Constructors

Constructor	Description
RingBufferLogEventTranslator()

Method Summary

Modifier and Type	Method	Description
(package private) void	clear()	Release references held by this object to allow objects to be garbage-collected.
void	setBasicValues(AsyncLogger anAsyncLogger, java.lang.String aLoggerName, Marker aMarker, java.lang.String theFqcn, Level aLevel, Message msg, java.lang.Throwable aThrowable, ThreadContext.ContextStack aContextStack, java.lang.StackTraceElement aLocation, Clock aClock, NanoClock aNanoClock)
void	translateTo(RingBufferLogEvent event, long sequence)
void	updateThreadValues()	Deprecated. since 2.25.0.

Methods inherited from class java.lang.Object

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

Field Detail

INJECTOR

private static final ContextDataInjector INJECTOR

asyncLogger

private AsyncLogger asyncLogger

loggerName

java.lang.String loggerName

marker

protected Marker marker

fqcn

protected java.lang.String fqcn

level

protected Level level

message

protected Message message

thrown

protected java.lang.Throwable thrown

contextStack

private ThreadContext.ContextStack contextStack

location

private java.lang.StackTraceElement location

clock

private Clock clock

nanoClock

private NanoClock nanoClock

threadId

private long threadId

threadName

private java.lang.String threadName

threadPriority

private int threadPriority

Constructor Detail

RingBufferLogEventTranslator

public RingBufferLogEventTranslator()

Method Detail

translateTo

public void translateTo(RingBufferLogEvent event,
                        long sequence)

Specified by:

translateTo in interface com.lmax.disruptor.EventTranslator<RingBufferLogEvent>

clear

void clear()

Release references held by this object to allow objects to be garbage-collected.

setBasicValues

public void setBasicValues(AsyncLogger anAsyncLogger,
                           java.lang.String aLoggerName,
                           Marker aMarker,
                           java.lang.String theFqcn,
                           Level aLevel,
                           Message msg,
                           java.lang.Throwable aThrowable,
                           ThreadContext.ContextStack aContextStack,
                           java.lang.StackTraceElement aLocation,
                           Clock aClock,
                           NanoClock aNanoClock)

updateThreadValues

@Deprecated
public void updateThreadValues()

Deprecated.

since 2.25.0. RingBufferLogEventTranslator instances should only be used on the thread that created it.