Package org.apache.logging.log4j.core.layout

Class GelfLayout

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.GelfLayout

All Implemented Interfaces:

Layout<java.lang.String>, Encoder<LogEvent>, StringLayout

@Plugin(name="GelfLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public final class GelfLayout
extends AbstractStringLayout

Lays out events in the Graylog Extended Log Format (GELF) 1.1.

This layout compresses JSON to GZIP or ZLIB (the compressionType) if log event data is larger than 1024 bytes (the compressionThreshold). This layout does not implement chunking.

See Also:

GELF specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GelfLayout.Builder<B extends GelfLayout.Builder<B>>
static class	GelfLayout.CompressionType

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

AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
GelfLayout(java.lang.String host, KeyValuePair[] additionalFields, GelfLayout.CompressionType compressionType, int compressionThreshold, boolean includeStacktrace)	Deprecated. Use newBuilder() instead

Method Summary

Modifier and Type	Method	Description
static GelfLayout	createLayout(java.lang.String host, KeyValuePair[] additionalFields, GelfLayout.CompressionType compressionType, int compressionThreshold, boolean includeStacktrace)	Deprecated. Use newBuilder() instead
void	encode(LogEvent event, ByteBufferDestination destination)	Encodes the specified source LogEvent to some binary representation and writes the result to the specified destination.
java.util.Map<java.lang.String,java.lang.String>	getContentFormat()	Returns a description of the content format.
java.lang.String	getContentType()	Returns the content type output by this layout.
static <B extends GelfLayout.Builder<B>> B	newBuilder()
byte[]	toByteArray(LogEvent event)	Formats the Log Event as a byte array.
java.lang.String	toSerializable(LogEvent event)	Formats the event as an Object that can be serialized.

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

getBytes, getCharset, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, serializeToBytes, serializeToString, trimToMaxSize

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

getConfiguration, markEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

GelfLayout

@Deprecated
public GelfLayout(java.lang.String host,
                  KeyValuePair[] additionalFields,
                  GelfLayout.CompressionType compressionType,
                  int compressionThreshold,
                  boolean includeStacktrace)

Deprecated.

Use newBuilder() instead

Method Detail

createLayout

@Deprecated
public static GelfLayout createLayout(@PluginAttribute("host")
                                      java.lang.String host,
                                      @PluginElement("AdditionalField")
                                      KeyValuePair[] additionalFields,
                                      @PluginAttribute(value="compressionType",defaultString="GZIP")
                                      GelfLayout.CompressionType compressionType,
                                      @PluginAttribute(value="compressionThreshold",defaultInt=1024)
                                      int compressionThreshold,
                                      @PluginAttribute(value="includeStacktrace",defaultBoolean=true)
                                      boolean includeStacktrace)

Deprecated.

Use newBuilder() instead

newBuilder

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

getContentFormat

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

Description copied from interface: Layout

Returns a description of the content format.

Specified by:

getContentFormat in interface Layout<java.lang.String>

Overrides:

getContentFormat in class AbstractLayout<java.lang.String>

Returns:

a Map of key/value pairs describing the Layout-specific content format, or an empty Map if no content format descriptors are specified.

getContentType

public java.lang.String getContentType()

Description copied from interface: Layout

Returns the content type output by this layout. The base class returns "text/plain".

Specified by:

getContentType in interface Layout<java.lang.String>

Overrides:

getContentType in class AbstractStringLayout

Returns:

The default content type for Strings.

toByteArray

public byte[] toByteArray(LogEvent event)

Description copied from class: AbstractStringLayout

Formats the Log Event as a byte array.

Specified by:

toByteArray in interface Layout<java.lang.String>

Overrides:

toByteArray in class AbstractStringLayout

Parameters:

event - The Log Event.

Returns:

The formatted event as a byte array.

encode

public void encode(LogEvent event,
                   ByteBufferDestination destination)

Description copied from class: AbstractLayout

Encodes the specified source LogEvent to some binary representation and writes the result to the specified destination.

The default implementation of this method delegates to the Layout.toByteArray(LogEvent) method which allocates temporary objects.

Subclasses can override this method to provide a garbage-free implementation. For text-based layouts, AbstractStringLayout provides various convenience methods to help with this:

@Plugin(name = "MyLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)
 public final class MyLayout extends AbstractStringLayout {

Specified by:

encode in interface Encoder<LogEvent>

Overrides:

encode in class AbstractLayout<java.lang.String>

Parameters:

event - the LogEvent to encode.

destination - holds the ByteBuffer to write into.

See Also:

AbstractStringLayout.getStringBuilder(), AbstractStringLayout.getStringBuilderEncoder()

toSerializable

public java.lang.String toSerializable(LogEvent event)

Description copied from interface: Layout

Formats the event as an Object that can be serialized.

Parameters:

event - The Logging Event.

Returns:

The formatted event.