[LOG4J2-2504] Missing JavaDoc in ThrowablePatternConverter newInstance(Configuration, String[])

• Type: Documentation
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 2.8.2, 2.11.1
• Component/s: Pattern Converters
• Assignee: Unassigned
• Reporter: Juri Berlanda
• Created: 13/Nov/18 10:53
• Updated: 13/Nov/18 10:53

Description

While upgrading from Log4j 2.7 to the most recent 2.11.1 I noticed, that the API for ThrowablePatternConverter changed.

It used to be (up until 2.8.1):

ThrowablePatternConverter newInstance(final String[] options)

but starting from 2.8.2 it is:

ThrowablePatternConverter newInstance(final Configuration config, final String[] options)

The new Parameter is not described in JavaDoc and I cannot figure out how I would get a Configuration object which would cause it to behave the same as with 2.7.

In addition: I think it would be a good idea to add a convenience ThrowablePatternConverter newInstance(final String[] options) which uses said default Configuration both to easy upgrades, and to allow backwards compatibility for stuff compiled against 2.7 (in my case a LogEventPatternConverter deployed toTomcat).