[LOG4J2-1838] Add support for appending common suffix to each line of throwable stack trace

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.8.1
• Fix Version/s: 2.8.2
• Component/s: Pattern Converters
• Labels: features
• Assignee: Matt Sicker
• Reporter: Zilong Song
• Created: 05/Mar/17 17:49
• Updated: 25/Jan/18 20:22
• Resolved: 08/Mar/17 04:02

Description

Add support for appending common suffix to each line of throwable stack trace. The suffix can be configured by patterns just like patterns used elsewhere.

For example, pattern %xEx{suffix(- %mdc{key})} will append a string generated by pattern - and %mdc{key}.

But patterns that handles throwable will be automatically ignored, because they will make the rendered result confusing. So pattern %xEx{suffix(- %rEx%mdc{key})} has the same effect with %xEx{suffix(- %mdc{key})}, as if the nested %rEx pattern has never appeared.

Following is an example of the with such suffix:

stack trace, with pattern "%xEx{suffix(- %mdc{key})}" and MDC(key)="test mdc suffix"

java.lang.IllegalArgumentException: IllegalArgument - test mdc suffix
	at org.apache.logging.log4j.core.pattern.ExtendedThrowablePatternConverterTest.testSuffixFromNormalPattern(ExtendedThrowablePatternConverterTest.java:48) [test-classes/:?] - test mdc suffix
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[?:1.8.0_91] - test mdc suffix
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[?:1.8.0_91] - test mdc suffix
	at java.lang.reflect.Method.invoke(Method.java:498) ~[?:1.8.0_91] - test mdc suffix
	at com.intellij.rt.execution.application.AppMain.main(AppMain.java:147) [idea_rt.jar:?] - test mdc suffix
Caused by: java.lang.NullPointerException: null pointer - test mdc suffix
	at org.apache.logging.log4j.core.pattern.ExtendedThrowablePatternConverterTest.testSuffixFromNormalPattern(ExtendedThrowablePatternConverterTest.java:47) ~[test-classes/:?] - test mdc suffix
	... 27 more - test mdc suffix
}}

Issue Links

• contains: LOG4J2-1561 print expected mdc info to each line of the exception stacktrace
• incorporates: LOG4J2-1843 Line-wise common suffix support for %ex pattern
• links to: GitHub Pull Request #61