Details
-
Documentation
-
Status: Open
-
Minor
-
Resolution: Unresolved
-
2.17.2
-
None
-
None
Description
Hi,
I think there may be a documentation error in the BurstFilter manual:
https://logging.apache.org/log4j/2.x/manual/filters.html#BurstFilter
https://github.com/apache/logging-log4j2/blob/rel/2.17.2/src/site/xdoc/manual/filters.xml#L87
The documentation states the following:
maxBurst | integer | The maximum number of events that can occur before events are filtered for exceeding the average rate. The default is 10 times the rate. |
But if I'm understanding the Burstfilter code correctly, the actual default maxBurst value is rate * DEFAULT_RATE_MULTIPLE, which is 100 and not 10:
If I'm correct I would suggest to update the aforementioned manual, and other possible related mistakes (javadoc ?).