Module ch.qos.logback.classic

Package ch.qos.logback.classic.encoder

Class JsonEncoder

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.encoder.EncoderBase<ILoggingEvent>

ch.qos.logback.classic.encoder.JsonEncoder

All Implemented Interfaces:

Encoder<ILoggingEvent>, ContextAware, LifeCycle

public class JsonEncoder
extends EncoderBase<ILoggingEvent>

https://jsonlines.org/ https://datatracker.ietf.org/doc/html/rfc8259

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGUMENT_ARRAY_ATTR_NAME
static final String	BIRTHDATE_ATTR_NAME
static final String	CAUSE_ATTR_NAME
static final String	CLASS_NAME_ATTR_NAME
static final String	COMMON_FRAMES_COUNT_ATTR_NAME
static final String	CONTEXT_ATTR_NAME
static final String	CONTEXT_PROPERTIES_ATTR_NAME
static final String	FORMATTED_MESSAGE_ATTR_NAME
static final String	KEY_VALUE_PAIRS_ATTR_NAME
static final String	LEVEL_ATTR_NAME
static final String	LOGGER_ATTR_NAME
static final String	MARKERS_ATTR_NAME
static final String	MDC_ATTR_NAME
static final String	MESSAGE_ATTR_NAME
static final String	METHOD_NAME_ATTR_NAME
static final String	NAME_ATTR_NAME
static final String	NANOSECONDS_ATTR_NAME
static final String	SEQUENCE_NUMBER_ATTR_NAME
static final String	STEP_ARRAY_NAME_ATTRIBUTE
static final String	SUPPRESSED_ATTR_NAME
static final String	THREAD_NAME_ATTR_NAME
static final String	THROWABLE_ATTR_NAME
static final String	TIMESTAMP_ATTR_NAME

Fields inherited from class ch.qos.logback.core.encoder.EncoderBase

started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
JsonEncoder()

Method Summary

Modifier and Type	Method	Description
byte[]	encode(ILoggingEvent event)	Encode an event as bytes.
byte[]	footerBytes()	Get footer bytes.
byte[]	headerBytes()	Get header bytes.
void	setWithArguments(boolean withArguments)
void	setWithContext(boolean withContext)
void	setWithFormattedMessage(boolean withFormattedMessage)
void	setWithKVPList(boolean withKVPList)
void	setWithLevel(boolean withLevel)
void	setWithLoggerName(boolean withLoggerName)
void	setWithMarkers(boolean withMarkers)
void	setWithMDC(boolean withMDC)
void	setWithMessage(boolean withMessage)
void	setWithNanoseconds(boolean withNanoseconds)
void	setWithSequenceNumber(boolean withSequenceNumber)
void	setWithThreadName(boolean withThreadName)
void	setWithThrowable(boolean withThrowable)
void	setWithTimestamp(boolean withTimestamp)

Methods inherited from class ch.qos.logback.core.encoder.EncoderBase

isStarted, start, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Details

CONTEXT_ATTR_NAME

public static final String CONTEXT_ATTR_NAME

See Also:

• Constant Field Values

NAME_ATTR_NAME

public static final String NAME_ATTR_NAME

See Also:

• Constant Field Values

BIRTHDATE_ATTR_NAME

public static final String BIRTHDATE_ATTR_NAME

See Also:

• Constant Field Values

CONTEXT_PROPERTIES_ATTR_NAME

public static final String CONTEXT_PROPERTIES_ATTR_NAME

See Also:

• Constant Field Values

TIMESTAMP_ATTR_NAME

public static final String TIMESTAMP_ATTR_NAME

See Also:

• Constant Field Values

NANOSECONDS_ATTR_NAME

public static final String NANOSECONDS_ATTR_NAME

See Also:

• Constant Field Values

SEQUENCE_NUMBER_ATTR_NAME

public static final String SEQUENCE_NUMBER_ATTR_NAME

See Also:

• Constant Field Values

LEVEL_ATTR_NAME

public static final String LEVEL_ATTR_NAME

See Also:

• Constant Field Values

MARKERS_ATTR_NAME

public static final String MARKERS_ATTR_NAME

See Also:

• Constant Field Values

THREAD_NAME_ATTR_NAME

public static final String THREAD_NAME_ATTR_NAME

See Also:

• Constant Field Values

MDC_ATTR_NAME

public static final String MDC_ATTR_NAME

See Also:

• Constant Field Values

LOGGER_ATTR_NAME

public static final String LOGGER_ATTR_NAME

See Also:

• Constant Field Values

MESSAGE_ATTR_NAME

public static final String MESSAGE_ATTR_NAME

See Also:

• Constant Field Values

FORMATTED_MESSAGE_ATTR_NAME

public static final String FORMATTED_MESSAGE_ATTR_NAME

See Also:

• Constant Field Values

ARGUMENT_ARRAY_ATTR_NAME

public static final String ARGUMENT_ARRAY_ATTR_NAME

See Also:

• Constant Field Values

KEY_VALUE_PAIRS_ATTR_NAME

public static final String KEY_VALUE_PAIRS_ATTR_NAME

See Also:

• Constant Field Values

THROWABLE_ATTR_NAME

public static final String THROWABLE_ATTR_NAME

See Also:

• Constant Field Values

CAUSE_ATTR_NAME

public static final String CAUSE_ATTR_NAME

See Also:

• Constant Field Values

SUPPRESSED_ATTR_NAME

public static final String SUPPRESSED_ATTR_NAME

See Also:

• Constant Field Values

COMMON_FRAMES_COUNT_ATTR_NAME

public static final String COMMON_FRAMES_COUNT_ATTR_NAME

See Also:

• Constant Field Values

CLASS_NAME_ATTR_NAME

public static final String CLASS_NAME_ATTR_NAME

See Also:

• Constant Field Values

METHOD_NAME_ATTR_NAME

public static final String METHOD_NAME_ATTR_NAME

See Also:

• Constant Field Values

STEP_ARRAY_NAME_ATTRIBUTE

public static final String STEP_ARRAY_NAME_ATTRIBUTE

See Also:

• Constant Field Values

Constructor Details

JsonEncoder

public JsonEncoder()

Method Details

headerBytes

public byte[] headerBytes()

Description copied from interface: Encoder

Get header bytes. This method is typically called upon opening of an output stream.

Returns:

header bytes. Null values are allowed.

encode

public byte[] encode(ILoggingEvent event)

Description copied from interface: Encoder

Encode an event as bytes.

Parameters:

event -

footerBytes

public byte[] footerBytes()

Description copied from interface: Encoder

Get footer bytes. This method is typically called prior to the closing of the stream where events are written.

Returns:

footer bytes. Null values are allowed.

setWithSequenceNumber

public void setWithSequenceNumber(boolean withSequenceNumber)

Parameters:

withSequenceNumber -

Since:

1.5.0

setWithTimestamp

public void setWithTimestamp(boolean withTimestamp)

Parameters:

withTimestamp -

Since:

1.5.0

setWithNanoseconds

public void setWithNanoseconds(boolean withNanoseconds)

Parameters:

withNanoseconds -

Since:

1.5.0

setWithLevel

public void setWithLevel(boolean withLevel)

setWithThreadName

public void setWithThreadName(boolean withThreadName)

setWithLoggerName

public void setWithLoggerName(boolean withLoggerName)

setWithContext

public void setWithContext(boolean withContext)

setWithMarkers

public void setWithMarkers(boolean withMarkers)

setWithMDC

public void setWithMDC(boolean withMDC)

setWithKVPList

public void setWithKVPList(boolean withKVPList)

setWithMessage

public void setWithMessage(boolean withMessage)

setWithArguments

public void setWithArguments(boolean withArguments)

setWithThrowable

public void setWithThrowable(boolean withThrowable)

setWithFormattedMessage

public void setWithFormattedMessage(boolean withFormattedMessage)