You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2017/05/27 06:51:44 UTC
logging-log4j2 git commit: LOG4J2-1911 Improve the documentation of
the DynamicThresholdFilter
Repository: logging-log4j2
Updated Branches:
refs/heads/master 7b043f6a8 -> 189070de4
LOG4J2-1911 Improve the documentation of the DynamicThresholdFilter
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/189070de
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/189070de
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/189070de
Branch: refs/heads/master
Commit: 189070de459169d0af7ca24df9654ac924402ace
Parents: 7b043f6
Author: Ralph Goers <rg...@nextiva.com>
Authored: Fri May 26 23:51:29 2017 -0700
Committer: Ralph Goers <rg...@nextiva.com>
Committed: Fri May 26 23:51:39 2017 -0700
----------------------------------------------------------------------
src/changes/changes.xml | 3 +++
src/site/xdoc/manual/filters.xml | 13 ++++++++++---
2 files changed, 13 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/189070de/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 949d717..3863f37 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -31,6 +31,9 @@
- "remove" - Removed
-->
<release version="2.9.0" date="2017-MM-DD" description="GA Release 2.9.0">
+ <action issue="LOG4J2-1911" dev="rgoers" type="fix">
+ Improve the documentation of the DynamicThresholdFilter.
+ </action>
<action issue="LOG4J2-1442" dev="mikes" type="add">
Generic HTTP appender.
</action>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/189070de/src/site/xdoc/manual/filters.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/filters.xml b/src/site/xdoc/manual/filters.xml
index 2bf527b..b70bc00 100644
--- a/src/site/xdoc/manual/filters.xml
+++ b/src/site/xdoc/manual/filters.xml
@@ -169,7 +169,8 @@
<p>
The DynamicThresholdFilter allows filtering by log level based on specific attributes. For example,
if the user's loginId is being captured in the ThreadContext Map then it is possible to enable
- debug logging for only that user.
+ debug logging for only that user. If the log event does not contain the specified ThreadContext item
+ NEUTRAL will be returned.
</p>
<table>
<caption align="top">Dynamic Threshold Filter Parameters</caption>
@@ -179,10 +180,16 @@
<th>Description</th>
</tr>
<tr>
+ <td>key</td>
+ <td>String</td>
+ <td>The name of the item in the ThreadContext Map to compare.</td>
+ </tr>
+ <tr>
<td>defaultThreshold</td>
<td>String</td>
- <td>Level of messages to be filtered. If there is no matching key in the key/value pairs
- then this level will be compared against the event's level.
+ <td>Level of messages to be filtered. The default threshold only applies if the log event contains
+ the specified ThreadContext Map item and its value does not match any key in
+ the key/value pairs.
</td>
</tr>
<tr>