Package org.apache.logging.log4j.core.pattern

Class HighlightConverter

  • All Implemented Interfaces:
    PatternConverter
    @Plugin(name="highlight",
        category="Converter")
public final class HighlightConverter
extends LogEventPatternConverter
    Highlight pattern converter. Formats the result of a pattern using a color appropriate for the Level in the LogEvent.

    For example: 

     %highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}

    You can define custom colors for each Level: 

     %highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{FATAL=red, ERROR=red, WARN=yellow, INFO=green, DEBUG=cyan,
 TRACE=black}

    You can use a predefined style: 

     %highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{STYLE=DEFAULT}

    The available predefined styles are:

    • Default
    • Log4j - The same as Default
    • Logback

    You can use whitespace around the comma and equal sign. The names in values MUST come from the AnsiEscape enum, case is normalized to upper-case internally.

    To disable ANSI output unconditionally, specify an additional option disableAnsi=true, or to disable ANSI output if no console is detected, specify option noConsoleNoAnsi=true e.g.. 

     %highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{STYLE=DEFAULT, noConsoleNoAnsi=true}

    • Method Detail

      • newInstance

        public static HighlightConverter newInstance​(Configuration config,
                                             String[] options)
        Gets an instance of the class.
        Parameters:
        config - The current Configuration.
        options - pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.
        Returns:
        instance of class.

      • format

        public void format​(LogEvent event,
                   StringBuilder toAppendTo)
        Formats an event into a string buffer.
        Specified by:
        format in class LogEventPatternConverter
        Parameters:
        event - event to format, may not be null.
        toAppendTo - string buffer to which the formatted event will be appended. May not be null.

      • handlesThrowable

        public boolean handlesThrowable()
        Description copied from class: LogEventPatternConverter
        Tests whether this pattern converter is renders a Throwable.

        The PatternParser checks this flag when processing the alwaysWriteExceptions option: if no converter in the pattern handles throwables, the parser automatically appends a converter to ensure exceptions are still written.

        Overrides:
        handlesThrowable in class LogEventPatternConverter
        Returns:
        true if this converter consumes and renders a Throwable, false otherwise