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

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

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

      • createChecker

        private ListChecker createChecker​(java.lang.String excludes,
                                  java.lang.String includes)

      • getHost

        public java.lang.String getHost()

      • 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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String mapMessageExcludes)
        A comma separated list of MapMessage keys to exclude;
        Parameters:
        mapMessageExcludes - the list of keys.
        Returns:
        this builder

      • setThreadContextPrefix

        public B setThreadContextPrefix​(java.lang.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​(java.lang.String prefix)
        The String to prefix the MapMessage attributes.
        Parameters:
        prefix - The prefix value. Null values will be ignored.
        Returns:
        this builder.