Class StructuredLogEncoder

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

org.springframework.boot.logging.logback.StructuredLogEncoder

All Implemented Interfaces:

Encoder<ILoggingEvent>, ContextAware, LifeCycle

public class StructuredLogEncoder
extends EncoderBase<ILoggingEvent>

Logback encoder for structured logging.

Since:

3.4.0

Author:

Moritz Halbritter, Phillip Webb

See Also:

• StructuredLogFormatter

Field Summary

Fields inherited from class EncoderBase

started

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
StructuredLogEncoder()

Method Summary

Modifier and Type	Method	Description
byte[]	encode(ILoggingEvent event)
byte @Nullable []	footerBytes()
byte @Nullable []	headerBytes()
void	setCharset(@Nullable Charset charset)
void	setFormat(String format)
void	start()
void	stop()

Methods inherited from class EncoderBase

isStarted

Methods inherited from class ContextAwareBase

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

Methods inherited from class Object

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

Methods inherited from interface ContextAware

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

Constructor Details

StructuredLogEncoder

public StructuredLogEncoder()

Method Details

setFormat

public void setFormat(String format)

setCharset

public void setCharset(@Nullable Charset charset)

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class EncoderBase<ILoggingEvent>

stop

public void stop()

Specified by:

stop in interface LifeCycle

Overrides:

stop in class EncoderBase<ILoggingEvent>

headerBytes

public byte @Nullable [] headerBytes()

encode

public byte[] encode(ILoggingEvent event)

footerBytes

public byte @Nullable [] footerBytes()