Skip to content

Fix BurstFilter documentation regarding the level parameter #3983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 10, 2025
+3 −4
Merged

Fix BurstFilter documentation regarding the level parameter #3983

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd436e4
Fix BurstFilter documentation regarding the level parameter
mlangc Nov 9, 2025
6d042b5
Improve typesetting
vy Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions src/site/antora/modules/ROOT/pages/manual/filters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`
Expand Down