Class HighlightConverter

  extended by org.apache.logging.log4j.core.pattern.AbstractPatternConverter
      extended by org.apache.logging.log4j.core.pattern.LogEventPatternConverter
          extended by org.apache.logging.log4j.core.pattern.HighlightConverter
All Implemented Interfaces:

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,

You can use a predefined style:

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

The available predefined styles are:

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.

Field Summary
Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
Method Summary
 void format(LogEvent event, StringBuilder toAppendTo)
          Formats an event into a string buffer.
 boolean handlesThrowable()
          Normally pattern converters are not meant to handle Exceptions although few pattern converters might.
static HighlightConverter newInstance(Configuration config, String[] options)
          Gets an instance of the class.
Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail


public static HighlightConverter newInstance(Configuration config,
                                             String[] options)
Gets an instance of the class.

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.
instance of class.


public void format(LogEvent event,
                   StringBuilder toAppendTo)
Formats an event into a string buffer.

Specified by:
format in class LogEventPatternConverter
event - event to format, may not be null.
toAppendTo - string buffer to which the formatted event will be appended. May not be null.


public boolean handlesThrowable()
Description copied from class: LogEventPatternConverter
Normally pattern converters are not meant to handle Exceptions although few pattern converters might.

By examining the return values for this method, the containing layout will determine whether it handles throwables or not.

handlesThrowable in class LogEventPatternConverter
true if this PatternConverter handles throwables

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.