You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by pk...@apache.org on 2024/07/08 12:16:43 UTC
(logging-log4j2) 05/08: Apply review suggestions (2)
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 632b429738800a20f2979deefc31f149610d6c90
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Mon Jul 8 09:34:54 2024 +0200
Apply review suggestions (2)
---
.../antora/modules/ROOT/pages/manual/filters.adoc | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/src/site/antora/modules/ROOT/pages/manual/filters.adoc b/src/site/antora/modules/ROOT/pages/manual/filters.adoc
index 392e75e5f3..ef0be72178 100644
--- a/src/site/antora/modules/ROOT/pages/manual/filters.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/filters.adoc
@@ -20,11 +20,13 @@
Filters are Log4j plugins that evaluate the parameters of a logging call or a log event and return one of three results:
-ACCEPT:: The log event is accepted by the filter and goes to the next stage of the logging pipeline.
+ACCEPT:: The filter accepts the log event.
+Other filters in the same filtering stage are not evaluated.
-DENY:: The log event is unconditionally dropped.
+DENY:: The filter drops the log event.
NEUTRAL:: Log4j behaves as if the filter was not present.
+It is evaluated by the next filter in the filter chain.
Filters can be used at each level of the
xref:manual/architecture.adoc#architecture-diagram[logging pipeline]:
@@ -117,6 +119,8 @@ xref:manual/appenders.adoc#AsyncAppender[asynchronous appenders].
....
@startuml
start
+:LogEvent;
+
group LoggerConfig
repeat
@@ -150,8 +154,9 @@ until it reaches the logger that references the chosen appender.
[plantuml]
....
@startuml
-!pragma useVerticalIf on
start
+:LogEvent;
+
group AppenderControl
:AppenderControl#callAppender();
@@ -189,9 +194,9 @@ of the appender reference.
....
@startuml
start
-group Appender
+:LogEvent;
-:Appender#append();
+group Appender
if (Apply appender filter) then (DENY)
#pink:Discard;
@@ -201,7 +206,7 @@ else (not DENY)
label a1
endif
end group
-#palegreen:Log message;
+#palegreen:Appender#append();
@enduml
....
@@ -322,7 +327,7 @@ The `Filters` plugin sequentially evaluates each sub-filter and:
* if the sub-filter return `NEUTRAL`, the `Filters` plugin evaluates the next sub-filter in the chain.
* if the last sub-filter returns `NEUTRAL`, the `Filters` plugin returns `NEUTRAL`.
-The `Filters` plugin together with the ternary logic of filters, can be used to express all the boolean operators.
+The `Filters` plugin together with the ternary logic of filters, can be used to express most boolean operators.
In the following examples `A` and `B` are two filters.
`NOT A`::