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

Class GelfLayout.Builder<B extends GelfLayout.Builder<B>>

java.lang.Object
org.apache.logging.log4j.core.layout.AbstractLayout.Builder<B>
org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder<B>
org.apache.logging.log4j.core.layout.GelfLayout.Builder<B>
All Implemented Interfaces:
Builder<GelfLayout>
Enclosing class:
GelfLayout
public static class GelfLayout.Builder<B extends GelfLayout.Builder<B>> extends AbstractStringLayout.Builder<B> implements Builder<GelfLayout>

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public GelfLayout build()
      Description copied from interface: Builder
      Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.
      Specified by:
      build in interface Builder<B extends GelfLayout.Builder<B>>
      Returns:
      the configured instance.

    • getHost

      public String getHost()

    • getCompressionType

      public GelfLayout.CompressionType getCompressionType()

    • getCompressionThreshold

      public int getCompressionThreshold()

    • isIncludeStacktrace

      public boolean isIncludeStacktrace()

    • isIncludeThreadContext

      public boolean isIncludeThreadContext()

    • isIncludeNullDelimiter

      public boolean isIncludeNullDelimiter()

    • isIncludeNewLineDelimiter

      public boolean isIncludeNewLineDelimiter()

    • getAdditionalFields

      public KeyValuePair[] getAdditionalFields()

    • setHost

      public B setHost(String host)
      The value of the host property (optional, defaults to local host name).
      Returns:
      this builder

    • setCompressionType

      public B setCompressionType(GelfLayout.CompressionType compressionType)
      Compression to use (optional, defaults to GZIP).
      Returns:
      this builder

    • setCompressionThreshold

      public B setCompressionThreshold(int compressionThreshold)
      Compress if data is larger than this number of bytes (optional, defaults to 1024).
      Returns:
      this builder

    • setIncludeStacktrace

      public B setIncludeStacktrace(boolean includeStacktrace)
      Whether to include full stacktrace of logged Throwables (optional, default to true). If set to false, only the class name and message of the Throwable will be included.
      Returns:
      this builder

    • setIncludeThreadContext

      public B setIncludeThreadContext(boolean includeThreadContext)
      Whether to include thread context as additional fields (optional, default to true).
      Returns:
      this builder

    • setIncludeNullDelimiter

      public B setIncludeNullDelimiter(boolean includeNullDelimiter)
      Whether to include NULL byte as delimiter after each event (optional, default to false). Useful for Graylog GELF TCP input.
      Returns:
      this builder

    • setIncludeNewLineDelimiter

      public B setIncludeNewLineDelimiter(boolean includeNewLineDelimiter)
      Whether to include newline (LF) as delimiter after each event (optional, default to false).
      Returns:
      this builder

    • setAdditionalFields

      public B setAdditionalFields(KeyValuePair[] additionalFields)
      Additional fields to set on each log event.
      Returns:
      this builder

    • setMessagePattern

      public B setMessagePattern(String pattern)
      The pattern to use to format the message.
      Parameters:
      pattern - the pattern string.
      Returns:
      this builder

    • setPatternSelector

      public B setPatternSelector(PatternSelector patternSelector)
      The PatternSelector to use to format the message.
      Parameters:
      patternSelector - the PatternSelector.
      Returns:
      this builder

    • setMdcIncludes

      public B setMdcIncludes(String mdcIncludes)
      A comma separated list of thread context keys to include;
      Parameters:
      mdcIncludes - the list of keys.
      Returns:
      this builder

    • setMdcExcludes

      public B setMdcExcludes(String mdcExcludes)
      A comma separated list of thread context keys to include;
      Parameters:
      mdcExcludes - the list of keys.
      Returns:
      this builder

    • setIncludeMapMessage

      public B setIncludeMapMessage(boolean includeMapMessage)
      Whether to include MapMessage fields as additional fields (optional, default to true).
      Returns:
      this builder

    • setMapMessageIncludes

      public B setMapMessageIncludes(String mapMessageIncludes)
      A comma separated list of thread context keys to include;
      Parameters:
      mapMessageIncludes - the list of keys.
      Returns:
      this builder

    • setMapMessageExcludes

      public B setMapMessageExcludes(String mapMessageExcludes)
      A comma separated list of MapMessage keys to exclude;
      Parameters:
      mapMessageExcludes - the list of keys.
      Returns:
      this builder

    • setThreadContextPrefix

      public B setThreadContextPrefix(String prefix)
      The String to prefix the ThreadContext attributes.
      Parameters:
      prefix - The prefix value. Null values will be ignored.
      Returns:
      this builder.

    • setMapPrefix

      public B setMapPrefix(String prefix)
      The String to prefix the MapMessage attributes.
      Parameters:
      prefix - The prefix value. Null values will be ignored.
      Returns:
      this builder.

    • setThreadContextIncludes

      public B setThreadContextIncludes(String threadContextIncludes)
      Since:
      2.25.0

    • setThreadContextExcludes

      public B setThreadContextExcludes(String threadContextExcludes)
      Since:
      2.25.0

    • setOmitEmptyFields

      public B setOmitEmptyFields(boolean omitEmptyFields)
      Since:
      2.25.0