Class HighlightConverter
- All Implemented Interfaces:
AnsiConverter
,PatternConverter
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 option noConsoleNoAnsi=true
e.g..
%highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{STYLE=DEFAULT, noConsoleNoAnsi=true}
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
private final boolean
private final List
<PatternFormatter> private static final String
private static final String
private static final String
Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
LOGGER
Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
CATEGORY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
HighlightConverter
(List<PatternFormatter> patternFormatters, Map<String, String> levelStyles, boolean noAnsi) Construct the converter. -
Method Summary
Modifier and TypeMethodDescriptioncreateLevelStyleMap
(String[] options) Creates a level style map where values are ANSI escape sequences given configuration options inoption[1]
.void
format
(LogEvent event, StringBuilder toAppendTo) Formats an event into a string buffer.(package private) String
getLevelStyle
(Level level) boolean
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
-
Field Details
-
DEFAULT_STYLES
-
LOGBACK_STYLES
-
STYLE_KEY
- See Also:
-
STYLE_KEY_DEFAULT
- See Also:
-
STYLE_KEY_LOGBACK
- See Also:
-
STYLES
-
levelStyles
-
patternFormatters
-
noAnsi
private final boolean noAnsi -
defaultStyle
-
-
Constructor Details
-
HighlightConverter
private HighlightConverter(List<PatternFormatter> patternFormatters, Map<String, String> levelStyles, boolean noAnsi) Construct the converter.- Parameters:
patternFormatters
- The PatternFormatters to generate the text to manipulate.noAnsi
- If true, do not output ANSI escape codes.
-
-
Method Details
-
createLevelStyleMap
Creates a level style map where values are ANSI escape sequences given configuration options inoption[1]
.The format of the option string in
option[1]
is:Level1=Value, Level2=Value, ...
For example:
ERROR=red bold, WARN=yellow bold, INFO=green, ...
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.
- Parameters:
options
- The second slot can optionally contain the style map.- Returns:
- a new map
-
newInstance
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
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.
-
getLevelStyle
-
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
-