Class JsonWriterStructuredLogFormatter<E>

java.lang.Object

org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter<E>

Type Parameters:

E - the log event type

All Implemented Interfaces:

StructuredLogFormatter<E>

public abstract class JsonWriterStructuredLogFormatter<E>
extends Object
implements StructuredLogFormatter<E>

Base class for StructuredLogFormatter implementations that generates JSON using a JsonWriter.

Since:

3.4.0

Author:

Phillip Webb

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonWriterStructuredLogFormatter(Consumer<JsonWriter.Members<E>> members, @Nullable StructuredLoggingJsonMembersCustomizer<?> customizer)	Create a new JsonWriterStructuredLogFormatter instance with the given members.
protected	JsonWriterStructuredLogFormatter(JsonWriter<E> jsonWriter)	Create a new JsonWriterStructuredLogFormatter instance with the given JsonWriter.

Method Summary

Modifier and Type	Method	Description
String	format(E event)	Formats the given log event to a String.
byte[]	formatAsBytes(E event, Charset charset)	Formats the given log event to a byte array.

Methods inherited from class Object

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

Constructor Details

JsonWriterStructuredLogFormatter

protected JsonWriterStructuredLogFormatter(Consumer<JsonWriter.Members<E>> members,
 @Nullable StructuredLoggingJsonMembersCustomizer<?> customizer)

Create a new JsonWriterStructuredLogFormatter instance with the given members.

Parameters:

members - a consumer, which should configure the members

customizer - an optional customizer to apply

JsonWriterStructuredLogFormatter

protected JsonWriterStructuredLogFormatter(JsonWriter<E> jsonWriter)

Create a new JsonWriterStructuredLogFormatter instance with the given JsonWriter.

Parameters:

jsonWriter - the JsonWriter

Method Details

format

public String format(E event)

Description copied from interface: StructuredLogFormatter

Formats the given log event to a String.

Specified by:

format in interface StructuredLogFormatter<E>

Parameters:

event - the log event to write

Returns:

the formatted log event String

formatAsBytes

public byte[] formatAsBytes(E event,
 Charset charset)

Description copied from interface: StructuredLogFormatter

Formats the given log event to a byte array.

Specified by:

formatAsBytes in interface StructuredLogFormatter<E>

Parameters:

event - the log event to write

charset - the charset

Returns:

the formatted log event bytes