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

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.

  • Method Details

    • newInstance

      public static MdcPatternConverter newInstance(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, 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.

    • emptyVariableOutput

      public String emptyVariableOutput()
      Overrides:
      emptyVariableOutput in class LogEventPatternConverter
      Returns:
      the formatted output when the input variable (MDC, NDC, etc.) is empty