Package org.apache.unomi.extensions.log4j

Class SafeExtendedThrowablePatternConverter

java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.apache.logging.log4j.core.pattern.ThrowablePatternConverter
org.apache.unomi.extensions.log4j.SafeExtendedThrowablePatternConverter
All Implemented Interfaces:
org.apache.logging.log4j.core.pattern.PatternConverter
@Plugin(name="SafeExtendedThrowablePatternConverter", category="Converter", elementType="converter", printObject=true) public final class SafeExtendedThrowablePatternConverter extends org.apache.logging.log4j.core.pattern.ThrowablePatternConverter
Outputs the Throwable portion of the LoggingEvent as a full stack trace unless this converter's option is 'short', where it just outputs the first line of the trace, or if the number of lines to print is explicitly specified.

The extended stack trace will also include the location of where the class was loaded from and the version of the jar if available.

If the message of the throwable contains a carriage return or line feed character, it gets encoded to prevent log injection. Originally written by Benjamin Papez (Jahia) benjamin.papez@jahia.com Contributed to Apache Unomi by Jahia Solutions Group SA

  • Field Summary

    Fields inherited from class org.apache.logging.log4j.core.pattern.ThrowablePatternConverter

    formatters, options

    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

    Modifier and Type
    Method
    Description
    void
    format(org.apache.logging.log4j.core.LogEvent event, StringBuilder toAppendTo)
    static SafeExtendedThrowablePatternConverter
    newInstance(org.apache.logging.log4j.core.config.Configuration config, String[] options)
    Gets an instance of the class.

    Methods inherited from class org.apache.logging.log4j.core.pattern.ThrowablePatternConverter

    getOptions, getSuffix, handlesThrowable

    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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • newInstance

      public static SafeExtendedThrowablePatternConverter newInstance(org.apache.logging.log4j.core.config.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(org.apache.logging.log4j.core.LogEvent event, StringBuilder toAppendTo)
      Overrides:
      format in class org.apache.logging.log4j.core.pattern.ThrowablePatternConverter