Class MdcPatternConverter
- java.lang.Object
-
- org.apache.logging.log4j.core.pattern.AbstractPatternConverter
-
- org.apache.logging.log4j.core.pattern.LogEventPatternConverter
-
- org.apache.logging.log4j.core.pattern.MdcPatternConverter
-
- All Implemented Interfaces:
PatternConverter
@Plugin(name="MdcPatternConverter", category="Converter") public final class MdcPatternConverter extends LogEventPatternConverter
Able to handle the contents of the LogEvent's MDC and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
full
private java.lang.String
key
Name of property to output.private java.lang.String[]
keys
private static TriConsumer<java.lang.String,java.lang.Object,java.lang.StringBuilder>
WRITE_KEY_VALUES_INTO
-
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
Constructors Modifier Constructor Description private
MdcPatternConverter(java.lang.String[] options)
Private constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
appendFully(ReadOnlyStringMap contextData, java.lang.StringBuilder toAppendTo)
private static void
appendSelectedKeys(java.lang.String[] keys, ReadOnlyStringMap contextData, java.lang.StringBuilder sb)
void
format(LogEvent event, java.lang.StringBuilder toAppendTo)
Formats an event into a string buffer.static MdcPatternConverter
newInstance(java.lang.String[] options)
Obtains an instance of PropertiesPatternConverter.-
Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
format, handlesThrowable, isVariable
-
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
-
-
-
Field Detail
-
key
private final java.lang.String key
Name of property to output.
-
keys
private final java.lang.String[] keys
-
full
private final boolean full
-
WRITE_KEY_VALUES_INTO
private static final TriConsumer<java.lang.String,java.lang.Object,java.lang.StringBuilder> WRITE_KEY_VALUES_INTO
-
-
Method Detail
-
newInstance
public static MdcPatternConverter newInstance(java.lang.String[] options)
Obtains an instance of PropertiesPatternConverter.- Parameters:
options
- options, may be null or first element contains name of property to format.- Returns:
- instance of PropertiesPatternConverter.
-
format
public void format(LogEvent event, java.lang.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.
-
appendFully
private static void appendFully(ReadOnlyStringMap contextData, java.lang.StringBuilder toAppendTo)
-
appendSelectedKeys
private static void appendSelectedKeys(java.lang.String[] keys, ReadOnlyStringMap contextData, java.lang.StringBuilder sb)
-
-