[LOG4J2-3020] Logger.catching(Throwable) does not document level it is logging at

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.14.0
• Fix Version/s: 3.0.0, 2.14.1
• Component/s: Documentation
• Assignee: Volkan Yazici
• Reporter: Marcono1234
• Created: 13/Feb/21 18:39
• Updated: 26/Feb/21 18:55
• Resolved: 23/Feb/21 21:06

Description

The documentation of the method Logger.catching(Throwable) is not mentioning at which level it is logging at.
It appears AbstractLogger is logging at level ERROR, but without it being explicitly mentioned, I think expecting it to be logged at DEBUG might also be a reasonable expectation.

It would therefore be good to explicitly mention the log level in the documentation.

---

As a side note: Personally I think the use case described by the catching documentation rather sounds like it should be logged at DEBUG:

In other cases where simply logging the fact that an exception was swallowed somewhere

To me that sounds like ignoring exceptions such as timeout exceptions and retrying an operation.

Issue Links

• is related to: LOG4J2-3021 Logger.throwing(Throwable) does not document level it is logging at
• links to: GitHub Pull Request #466