This is an automated email from the ASF dual-hosted git repository. pkarwasz pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit f161eba79f76ada7b3003c7df630a797c39d58c4 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Mon Jul 8 09:38:57 2024 +0200 Apply review suggestions (1) Co-authored-by: Volkan Yazıcı <[email protected]> --- .../antora/modules/ROOT/pages/manual/filters.adoc | 23 +++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/src/site/antora/modules/ROOT/pages/manual/filters.adoc b/src/site/antora/modules/ROOT/pages/manual/filters.adoc index 8c4d8a8ca1..392e75e5f3 100644 --- a/src/site/antora/modules/ROOT/pages/manual/filters.adoc +++ b/src/site/antora/modules/ROOT/pages/manual/filters.adoc @@ -120,7 +120,7 @@ start group LoggerConfig repeat -:LoggerConfig.log(); +:LoggerConfig#log(); if (Apply logger filter) then (DENY) #pink:Discard; @@ -154,7 +154,7 @@ until it reaches the logger that references the chosen appender. start group AppenderControl -:AppenderControl.callAppender(); +:AppenderControl#callAppender(); if (Is less severe then appender reference level?) then (yes) #pink:Discard; @@ -191,7 +191,7 @@ of the appender reference. start group Appender -:Appender.append(); +:Appender#append(); if (Apply appender filter) then (DENY) #pink:Discard; @@ -234,7 +234,7 @@ You should rather configure the filtering in one of the previous stages. [#example-configuration-file] === Example configuration file -The following example shows the order in which filters are evaluated: +The following example configuration file employs filters at all possible stages to explain their evaluation order: [tabs] ==== @@ -269,8 +269,8 @@ include::example$manual/filters/filters.properties[lines=17..-1] <1> Global filter <2> Logger `level` attribute (it is skipped if the event matches the global filter) -<3> Filter of the "org.example" logger -<4> Filter of the root logger (it is the parent of the "org.example" logger) +<3> Filter of the `org.example` logger +<4> Filter of the root logger (it is the parent of the `org.example` logger) <5> Appender reference `level` attribute <6> Filter of the appender reference <7> Filter of the appender @@ -365,7 +365,7 @@ Log4j Core provides the following filters out-of-the-box. [#timestamp-filters] === Timestamp filters -Timestamp filters use the timestamp of log events to decide whether to log them or not. +Timestamp filters use the timestamp of log events to decide whether to accept them or not. [#BurstFilter] ==== `BurstFilter` @@ -484,7 +484,7 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-loggin [#level-filters] === Level filters -The following filters allow you to filter log events based on their level. +The following filters allow you to filter log events based on their xref:manual/customloglevels.adoc[levels]. [#LevelMatchFilter] ==== `LevelMatchFilter` @@ -541,7 +541,8 @@ Besides the common configuration attributes, the `LevelRangeFilter` supports the [TIP] ==== Make sure not to invert the bounds of the range. -Starting from the smallest level, the Log4j API defines: `OFF`, +Starting from the smallest level, +{log4j2-url}/manual/customloglevels.adoc[the Log4j API defines]: `OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE` and `ALL`. ==== @@ -1167,7 +1168,7 @@ If set to `0`, polling is disabled. |=== -[CAUTION] +[WARNING] ==== Unlike other map filters that have a configurable matching mode, this filter always uses the <<matching-mode-or,OR>> matching mode. @@ -1314,7 +1315,7 @@ For the remaining filters, only these bindings are available: | logEvent | link:../javadoc/log4j-core/org/apache/logging/log4j/core/LogEvent.html[`LogEvent`] -| The LogEvent being processed. +| The log event being processed. | substitutor | link:../javadoc/log4j-core/org/apache/logging/log4j/core/lookup/StrSubstitutor.html[`StrSubstitutor`]
