net.logstash.logback.stacktrace

Class ShortenedThrowableConverter

java.lang.Object

ch.qos.logback.core.pattern.Converter<E>

ch.qos.logback.core.pattern.FormattingConverter<E>

ch.qos.logback.core.pattern.DynamicConverter<ILoggingEvent>

ch.qos.logback.classic.pattern.ClassicConverter

ch.qos.logback.classic.pattern.ThrowableHandlingConverter

net.logstash.logback.stacktrace.ShortenedThrowableConverter

All Implemented Interfaces:

ContextAware, LifeCycle

public class ShortenedThrowableConverter
extends ThrowableHandlingConverter

A ThrowableHandlingConverter (similar to logback's ThrowableProxyConverter) that formats stacktraces by doing the following:

• Limits the number of stackTraceElements per throwable (applies to each individual throwable. e.g. caused-bys and suppressed). See maxDepthPerThrowable.
• Limits the total length in characters of the trace. See maxLength.
• Abbreviates class names based on the shortenedClassNameLength. See shortenedClassNameLength.
• Filters out consecutive unwanted stackTraceElements based on regular expressions. See excludes.
• Uses evaluators to determine if the stacktrace should be logged. See evaluators.
• Outputs in either 'normal' order (root-cause-last), or root-cause-first. See rootCauseFirst.

To use this with a PatternLayout, you must configure conversionRule as described here. Options can be specified in the pattern in the following order:

1. maxDepthPerThrowable = "full" or "short" or an integer value
2. shortenedClassNameLength = "full" or "short" or an integer value
3. maxLength = "full" or "short" or an integer value

If any other remaining options are "rootFirst", then the converter awill be configured as root-cause-first. If any other remaining options equal to an evaluator name, then the evaluator will be used to determine if the stacktrace should be printed. Other options will be interpreted as exclusion regexes.

For example,

 
     <conversionRule conversionWord="stack"
                   converterClass="net.logstash.logback.stacktrace.ShortenedThrowableConverter" />

     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
             <pattern>[%thread] - %msg%n%stack{5,1024,10,rootFirst,regex1,regex2,evaluatorName}</pattern>
         </encoder>
     </appender>
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CLASS_NAME_LENGTH
static int	DEFAULT_MAX_DEPTH_PER_THROWABLE
static int	DEFAULT_MAX_LENGTH
static int	FULL_CLASS_NAME_LENGTH
static int	FULL_MAX_DEPTH_PER_THROWABLE
static int	FULL_MAX_LENGTH
static int	SHORT_CLASS_NAME_LENGTH
static int	SHORT_MAX_DEPTH_PER_THROWABLE
static int	SHORT_MAX_LENGTH

Fields inherited from class ch.qos.logback.core.pattern.DynamicConverter

started

Constructor Summary

Constructors

Constructor and Description
ShortenedThrowableConverter()

Method Summary

Modifier and Type	Method and Description
void	addEvaluator(EventEvaluator<ILoggingEvent> evaluator)
void	addExclude(String exclusionPattern)
String	convert(ILoggingEvent event)
List<EventEvaluator<ILoggingEvent>>	getEvaluators()
List<String>	getExcludes()
int	getMaxDepthPerThrowable()
int	getMaxLength()
int	getShortenedClassNameLength()
boolean	isInlineHash()
boolean	isRootCauseFirst()
void	setEvaluators(List<EventEvaluator<ILoggingEvent>> evaluators)
void	setExcludes(List<String> exclusionPatterns)
void	setExclusions(String comaSeparatedPatterns) Set exclusion patterns as a list of coma separated patterns
void	setInlineHash(boolean inlineHash)
void	setMaxDepthPerThrowable(int maxDepthPerThrowable)
void	setMaxLength(int maxLength)
void	setRootCauseFirst(boolean rootCauseFirst)
void	setShortenedClassNameLength(int length)
protected void	setStackHasher(StackHasher stackHasher)
void	start()

Methods inherited from class ch.qos.logback.core.pattern.DynamicConverter

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getFirstOption, getOptionList, isStarted, setContext, setOptionList, stop

Methods inherited from class ch.qos.logback.core.pattern.FormattingConverter

getFormattingInfo, setFormattingInfo, write

Methods inherited from class ch.qos.logback.core.pattern.Converter

getNext, setNext

Methods inherited from class java.lang.Object

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

Field Detail

FULL_MAX_DEPTH_PER_THROWABLE

public static final int FULL_MAX_DEPTH_PER_THROWABLE

See Also:

Constant Field Values

SHORT_MAX_DEPTH_PER_THROWABLE

public static final int SHORT_MAX_DEPTH_PER_THROWABLE

See Also:

Constant Field Values

DEFAULT_MAX_DEPTH_PER_THROWABLE

public static final int DEFAULT_MAX_DEPTH_PER_THROWABLE

See Also:

Constant Field Values

FULL_MAX_LENGTH

public static final int FULL_MAX_LENGTH

See Also:

Constant Field Values

SHORT_MAX_LENGTH

public static final int SHORT_MAX_LENGTH

See Also:

Constant Field Values

DEFAULT_MAX_LENGTH

public static final int DEFAULT_MAX_LENGTH

See Also:

Constant Field Values

FULL_CLASS_NAME_LENGTH

public static final int FULL_CLASS_NAME_LENGTH

See Also:

Constant Field Values

SHORT_CLASS_NAME_LENGTH

public static final int SHORT_CLASS_NAME_LENGTH

See Also:

Constant Field Values

DEFAULT_CLASS_NAME_LENGTH

public static final int DEFAULT_CLASS_NAME_LENGTH

See Also:

Constant Field Values

Constructor Detail

ShortenedThrowableConverter

public ShortenedThrowableConverter()

Method Detail

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class DynamicConverter<ILoggingEvent>

convert

public String convert(ILoggingEvent event)

Specified by:

convert in class Converter<ILoggingEvent>

getShortenedClassNameLength

public int getShortenedClassNameLength()

setShortenedClassNameLength

public void setShortenedClassNameLength(int length)

getMaxDepthPerThrowable

public int getMaxDepthPerThrowable()

setMaxDepthPerThrowable

public void setMaxDepthPerThrowable(int maxDepthPerThrowable)

setMaxLength

public void setMaxLength(int maxLength)

getMaxLength

public int getMaxLength()

isRootCauseFirst

public boolean isRootCauseFirst()

setRootCauseFirst

public void setRootCauseFirst(boolean rootCauseFirst)

isInlineHash

public boolean isInlineHash()

setInlineHash

public void setInlineHash(boolean inlineHash)

setStackHasher

protected void setStackHasher(StackHasher stackHasher)

addExclude

public void addExclude(String exclusionPattern)

setExclusions

public void setExclusions(String comaSeparatedPatterns)

Set exclusion patterns as a list of coma separated patterns

Parameters:

comaSeparatedPatterns - list of coma separated patterns

setExcludes

public void setExcludes(List<String> exclusionPatterns)

getExcludes

public List<String> getExcludes()

addEvaluator

public void addEvaluator(EventEvaluator<ILoggingEvent> evaluator)

setEvaluators

public void setEvaluators(List<EventEvaluator<ILoggingEvent>> evaluators)

getEvaluators

public List<EventEvaluator<ILoggingEvent>> getEvaluators()