Class HighlightConverter
- java.lang.Object
-
- org.apache.logging.log4j.core.pattern.AbstractPatternConverter
-
- org.apache.logging.log4j.core.pattern.LogEventPatternConverter
-
- org.apache.logging.log4j.core.pattern.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 asDefault
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 optionnoConsoleNoAnsi=true
e.g..%highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{STYLE=DEFAULT, noConsoleNoAnsi=true}
-
-
Field Summary
-
Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
CATEGORY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
format, isVariable
-
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
-
-
-
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 classLogEventPatternConverter
- 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
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.
- Overrides:
handlesThrowable
in classLogEventPatternConverter
- Returns:
- true if this PatternConverter handles throwables
-
-