This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 296d1d7c3d Fix `BurstFilter` documentation regarding the level
parameter (#3983)
296d1d7c3d is described below
commit 296d1d7c3d8d79771c1aa84f2a22dd0bdb18b0c3
Author: Matthias Langer <[email protected]>
AuthorDate: Mon Nov 10 10:36:11 2025 +0100
Fix `BurstFilter` documentation regarding the level parameter (#3983)
Co-authored-by: Volkan Yazıcı <[email protected]>
---
src/site/antora/modules/ROOT/pages/manual/filters.adoc | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/src/site/antora/modules/ROOT/pages/manual/filters.adoc
b/src/site/antora/modules/ROOT/pages/manual/filters.adoc
index be716654ae..f5ecc6f6f3 100644
--- a/src/site/antora/modules/ROOT/pages/manual/filters.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/filters.adoc
@@ -385,8 +385,7 @@ Timestamp filters use the timestamp of log events to decide
whether to accept th
[#BurstFilter]
==== `BurstFilter`
-The `BurstFilter` limits the rate of log events.
-The rate limit is only applied to log events less severe than a configured log
level.
+The `BurstFilter` limits the rate of log events at or below a configured
severity level.
Besides the <<common-configuration-attributes,common configuration
attributes>>,
the `BurstFilter` supports the following parameters:
@@ -399,8 +398,8 @@ the `BurstFilter` supports the following parameters:
| level
| link:../javadoc/log4j-api/org/apache/logging/log4j/Level.html[`Level`]
| link:../javadoc/log4j-api/org/apache/logging/log4j/Level.html#WARN[`WARN`]
-| The rate limit only applies to log events less severe than this level.
-Events at least as severe as this level will always match.
+| The rate limit is only applied up until and including this level.
+Events more severe than this level will always match.
| rate
| `float`
