Uploaded image for project: 'Log4j 2'
  1. Log4j 2
  2. LOG4J2-3552

Incorrect BurstFilter doc: the default maxBurst value is 100 times the rate, not 10

    XMLWordPrintableJSON

Details

    • Documentation
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 2.17.2
    • None
    • Documentation
    • 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:

      https://github.com/apache/logging-log4j2/blob/rel/2.17.2/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java#L341

      https://github.com/apache/logging-log4j2/blob/rel/2.17.2/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java#L63

      If I'm correct I would suggest to update the aforementioned manual, and other possible related mistakes (javadoc ?).

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            apocquet-ovh Alexandre Pocquet
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: