Class GelfLayout
- java.lang.Object
-
- org.apache.logging.log4j.core.layout.AbstractLayout<String>
-
- org.apache.logging.log4j.core.layout.AbstractStringLayout
-
- org.apache.logging.log4j.core.layout.GelfLayout
-
- All Implemented Interfaces:
Layout<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 (thecompressionThreshold
). 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(String host, KeyValuePair[] additionalFields, GelfLayout.CompressionType compressionType, int compressionThreshold, boolean includeStacktrace)
Deprecated.UsenewBuilder()
instead
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static GelfLayout
createLayout(String host, KeyValuePair[] additionalFields, GelfLayout.CompressionType compressionType, int compressionThreshold, boolean includeStacktrace)
Deprecated.UsenewBuilder()
insteadvoid
encode(LogEvent event, ByteBufferDestination destination)
Encodes the specified source LogEvent to some binary representation and writes the result to the specified destination.Map<String,String>
getContentFormat()
Returns a description of the content format.String
getContentType()
Returns the content type output by this layout.static <B extends GelfLayout.Builder<B>>
BnewBuilder()
byte[]
toByteArray(LogEvent event)
Formats the Log Event as a byte array.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
-
-
-
-
Constructor Detail
-
GelfLayout
@Deprecated public GelfLayout(String host, KeyValuePair[] additionalFields, GelfLayout.CompressionType compressionType, int compressionThreshold, boolean includeStacktrace)
Deprecated.UsenewBuilder()
instead
-
-
Method Detail
-
createLayout
@Deprecated public static GelfLayout createLayout(@PluginAttribute("host") 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.UsenewBuilder()
instead
-
newBuilder
@PluginBuilderFactory public static <B extends GelfLayout.Builder<B>> B newBuilder()
-
getContentFormat
public Map<String,String> getContentFormat()
Description copied from interface:Layout
Returns a description of the content format.- Specified by:
getContentFormat
in interfaceLayout<String>
- Overrides:
getContentFormat
in classAbstractLayout<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 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 interfaceLayout<String>
- Overrides:
getContentType
in classAbstractStringLayout
- 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 interfaceLayout<String>
- Overrides:
toByteArray
in classAbstractStringLayout
- 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 interfaceEncoder<LogEvent>
- Overrides:
encode
in classAbstractLayout<String>
- Parameters:
event
- the LogEvent to encode.destination
- holds the ByteBuffer to write into.- See Also:
AbstractStringLayout.getStringBuilder()
,AbstractStringLayout.getStringBuilderEncoder()
-
-