This is an automated email from the ASF dual-hosted git repository.
rgoers pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/release-2.x by this push:
new 8baa82b LOG4J2-2540 - Minor documentation fixes
8baa82b is described below
commit 8baa82b6292af0567e499a7c6a755a1d561b38ce
Author: Ralph Goers <[email protected]>
AuthorDate: Sun Dec 5 14:47:58 2021 -0700
LOG4J2-2540 - Minor documentation fixes
---
src/changes/changes.xml | 3 +++
src/site/xdoc/manual/architecture.xml | 7 ++++++-
src/site/xdoc/manual/configuration.xml.vm | 6 +++---
3 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 085a5ae..6752d42 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -116,6 +116,9 @@
Improve PatternLayout performance by reducing unnecessary indirection
and branching.
</action>
<!-- FIXES -->
+ <action issue="LOG4J2-2540" dev="rgoers">
+ Minor documentation correctsion regarding log levels.
+ </action>
<action issue="LOG4J2-2541" dev="rgoers" due-to="Gerold Broser">
Minor documentation corrections in the configuration section.
</action>
diff --git a/src/site/xdoc/manual/architecture.xml
b/src/site/xdoc/manual/architecture.xml
index 3cbd230..7061f02 100644
--- a/src/site/xdoc/manual/architecture.xml
+++ b/src/site/xdoc/manual/architecture.xml
@@ -174,10 +174,15 @@ Logger y = LogManager.getLogger("wombat");
<h5>Log Levels</h5>
<p>LoggerConfigs will be assigned a Log
<a
href="../log4j-api/apidocs/org/apache/logging/log4j/Level.html">Level</a>. The
set of built-in
- levels includes TRACE, DEBUG, INFO, WARN, ERROR, and FATAL. Log4j 2
also supports
+ levels includes ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, and
OFF. Log4j 2 also supports
<a href="customloglevels.html">custom log levels</a>.
Another mechanism for getting more granularity is to use
<a href="../log4j-api/api.html#Markers">Markers</a> instead.
+ The OFF and ALL levels are not intended to be used on calls to the
logging API. Specifying OFF in the
+ configuration implies no logging events should match while
specifying ALL would mean all events match,
+ including custom events. However, OFF can be used on logging API
calls in special cases where the event
+ should always be logged regardless of the configuration. However, it
is generally recommended that a Marker
+ with a corresponding global Marker Filter be used instead.
</p>
<p>
<a href="http://logging.apache.org/log4j/1.2/manual.html";>Log4j
1.x</a>
diff --git a/src/site/xdoc/manual/configuration.xml.vm
b/src/site/xdoc/manual/configuration.xml.vm
index 3d1c826..a42c486 100644
--- a/src/site/xdoc/manual/configuration.xml.vm
+++ b/src/site/xdoc/manual/configuration.xml.vm
@@ -597,9 +597,9 @@ public class Bar {
<tr>
<td>status</td>
<td><p>The level of internal Log4j events that should be
logged to the console.
- Valid values for this attribute are "trace", "debug", "info",
"warn", "error" and "fatal".
- Log4j will log details about initialization, rollover and
other internal actions to the status logger.
- Setting <tt>status="trace"</tt> is one of the first tools
available to you if you need to
+ Valid values for this attribute are "off", "trace", "debug",
"info", "warn", "error", "fatal", and
+ "all". Log4j will log details about initialization, rollover
and other internal actions to the status
+ logger. Setting <tt>status="trace"</tt> is one of the first
tools available to you if you need to
troubleshoot log4j.
</p><p>
(Alternatively, setting system property
<tt>log4j2.debug</tt> will also print internal Log4j2 logging
