org.apache.logging.log4j.core.layout

Class LogstashJsonLayout

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout<java.lang.String>

org.apache.logging.log4j.core.layout.AbstractStringLayout

org.apache.logging.log4j.core.layout.LogstashJsonLayout

All Implemented Interfaces:

org.apache.logging.log4j.core.Layout<java.lang.String>, org.apache.logging.log4j.core.layout.Encoder<org.apache.logging.log4j.core.LogEvent>, org.apache.logging.log4j.core.StringLayout

@Plugin(name="LogstashJsonLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public final class LogstashJsonLayout
extends org.apache.logging.log4j.core.layout.AbstractStringLayout

Appends a series of JSON events as strings serialized as bytes.

Complete well-formed JSON vs. fragment JSON

If you configure complete="true", the appender outputs a well-formed JSON document. By default, with complete="false", you should include the output as an external file in a separate file to form a well-formed JSON document.

If complete="false", the appender does not write the JSON open array character "[" at the start of the document, "]" and the end, nor comma "," between records.

Encoding

Appenders using this layout should have their charset set to UTF-8 or UTF-16, otherwise events containing non ASCII characters could result in corrupted log files.

Pretty vs. compact JSON

By default, the JSON layout is not compact (a.k.a. "pretty") with compact="false", which means the appender uses end-of-line characters and indents lines to format the text. If compact="true", then no end-of-line or indentation is used. Message content may contain, of course, escaped end-of-lines.

Additional Fields

This property allows addition of custom fields into generated JSON. <JsonLayout><KeyValuePair key="foo" value="bar"/></JsonLayout> inserts "foo":"bar" directly into JSON output. Supports Lookup expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	org.apache.logging.log4j.core.layout.AbstractJacksonLayout.ResolvableKeyValuePair
static class	LogstashJsonLayout.Builder<B extends LogstashJsonLayout.Builder<B>>
static class	LogstashJsonLayout.LogEventWithAdditionalFields

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer, org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer2

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.core.layout.AbstractJacksonLayout.ResolvableKeyValuePair[]	additionalFields
protected boolean	compact
protected static java.lang.String	COMPACT_EOL
protected boolean	complete
protected static java.lang.String	DEFAULT_EOL
protected java.lang.String	eol
protected boolean	includeNullDelimiter
protected com.fasterxml.jackson.databind.ObjectWriter	objectWriter

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

configuration, eventCount, footer, header, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Layout

ELEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
static LogstashJsonLayout	createDefaultLayout() Creates a JSON Layout using the default settings.
java.util.Map<java.lang.String,java.lang.String>	getContentFormat()
java.lang.String	getContentType()
byte[]	getFooter() Returns appropriate JSON footer.
byte[]	getHeader() Returns appropriate JSON header.
static <B extends LogstashJsonLayout.Builder<B>> B	newBuilder()
java.lang.String	toSerializable(org.apache.logging.log4j.core.LogEvent arg0)
void	toSerializable(org.apache.logging.log4j.core.LogEvent event, java.io.Writer writer)
protected static boolean	valueNeedsLookup(java.lang.String arg0)
java.lang.Object	wrapLogEvent(org.apache.logging.log4j.core.LogEvent event)

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

getBytes, getCharset, getFooterSerializer, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, serializeToBytes, serializeToString, toByteArray, trimToMaxSize

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

encode, getConfiguration, markEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.layout.Encoder

encode

Field Detail

DEFAULT_EOL

protected static final java.lang.String DEFAULT_EOL

See Also:

Constant Field Values

COMPACT_EOL

protected static final java.lang.String COMPACT_EOL

See Also:

Constant Field Values

eol

protected final java.lang.String eol

objectWriter

protected final com.fasterxml.jackson.databind.ObjectWriter objectWriter

compact

protected final boolean compact

complete

protected final boolean complete

includeNullDelimiter

protected final boolean includeNullDelimiter

additionalFields

protected final org.apache.logging.log4j.core.layout.AbstractJacksonLayout.ResolvableKeyValuePair[] additionalFields

Method Detail

getHeader

public byte[] getHeader()

Returns appropriate JSON header.

Specified by:

getHeader in interface org.apache.logging.log4j.core.Layout<java.lang.String>

Overrides:

getHeader in class org.apache.logging.log4j.core.layout.AbstractStringLayout

Returns:

a byte array containing the header, opening the JSON array.

getFooter

public byte[] getFooter()

Returns appropriate JSON footer.

Specified by:

getFooter in interface org.apache.logging.log4j.core.Layout<java.lang.String>

Overrides:

getFooter in class org.apache.logging.log4j.core.layout.AbstractStringLayout

Returns:

a byte array containing the footer, closing the JSON array.

getContentFormat

public java.util.Map<java.lang.String,java.lang.String> getContentFormat()

Specified by:

getContentFormat in interface org.apache.logging.log4j.core.Layout<java.lang.String>

Overrides:

getContentFormat in class org.apache.logging.log4j.core.layout.AbstractLayout<java.lang.String>

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface org.apache.logging.log4j.core.Layout<java.lang.String>

Overrides:

getContentType in class org.apache.logging.log4j.core.layout.AbstractStringLayout

Returns:

The content type.

newBuilder

@PluginBuilderFactory
public static <B extends LogstashJsonLayout.Builder<B>> B newBuilder()

createDefaultLayout

public static LogstashJsonLayout createDefaultLayout()

Creates a JSON Layout using the default settings. Useful for testing.

Returns:

A JSON Layout.

wrapLogEvent

public java.lang.Object wrapLogEvent(org.apache.logging.log4j.core.LogEvent event)

toSerializable

public void toSerializable(org.apache.logging.log4j.core.LogEvent event,
                           java.io.Writer writer)
                    throws java.io.IOException

Throws:

java.io.IOException

valueNeedsLookup

protected static boolean valueNeedsLookup(java.lang.String arg0)

toSerializable

public java.lang.String toSerializable(org.apache.logging.log4j.core.LogEvent arg0)