This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch doc/2.x/simple-and-status-logger
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to
refs/heads/doc/2.x/simple-and-status-logger by this push:
new 0803d4cf72 Add links
0803d4cf72 is described below
commit 0803d4cf72de31602bed402c5e33257d02c46841
Author: Volkan Yazıcı <[email protected]>
AuthorDate: Mon May 27 12:58:58 2024 +0200
Add links
---
src/site/antora/modules/ROOT/pages/faq.adoc | 4 ++--
src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc | 2 +-
src/site/antora/modules/ROOT/pages/manual/appenders.adoc | 8 +++++---
src/site/antora/modules/ROOT/pages/manual/configuration.adoc | 11 ++++++-----
src/site/antora/modules/ROOT/pages/manual/jmx.adoc | 4 ++--
src/site/antora/modules/ROOT/pages/manual/logsep.adoc | 2 +-
src/site/antora/modules/ROOT/pages/manual/scripts.adoc | 2 +-
.../antora/modules/ROOT/pages/manual/systemproperties.adoc | 10 +++++-----
.../manual/systemproperties/properties-log4j-core-misc.adoc | 2 +-
.../partials/manual/systemproperties/properties-provider.adoc | 2 +-
10 files changed, 25 insertions(+), 22 deletions(-)
diff --git a/src/site/antora/modules/ROOT/pages/faq.adoc
b/src/site/antora/modules/ROOT/pages/faq.adoc
index 5ec5661f32..418d0dc229 100644
--- a/src/site/antora/modules/ROOT/pages/faq.adoc
+++ b/src/site/antora/modules/ROOT/pages/faq.adoc
@@ -126,11 +126,11 @@ By default, Log4j looks for a configuration file named
`log4j2.xml` on the class
Note the `2` in the file name!
(See xref:manual/configuration.adoc[the Configuration page] for more details.)
-. Increase the logging verbosity of the internal status logger: +
+. Increase the logging verbosity of the internal
xref:manual/status-logger.adoc[]: +
`-Dlog4j2.statusLoggerLevel=TRACE`
. Enable all internal debug logging: `-Dlog4j2.debug`.
-This disables level-based status logger filtering and effectively allows all
status logs.
+This disables level-based xref:manual/status-logger.adoc[] filtering and
effectively allows all status logs.
[#separate_log_files]
== How do I dynamically write to separate log files?
diff --git a/src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc
b/src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc
index 4dd0239289..47f2c4e7bb 100644
--- a/src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc
+++ b/src/site/antora/modules/ROOT/pages/log4j-jmx-gui.adoc
@@ -16,7 +16,7 @@ Licensed to the Apache Software Foundation (ASF) under one or
more
////
= Log4j JMX GUI
-https://github.com/apache/logging-log4j-jmx-gui[The Apache Log4j JMX GUI] is a
basic client GUI that can be used to monitor the `StatusLogger` output and to
remotely modify the Log4j configuration.
+https://github.com/apache/logging-log4j-jmx-gui[The Apache Log4j JMX GUI] is a
basic client GUI that can be used to monitor the
xref:manual/status-logger.adoc[] output and to remotely modify the Log4j
configuration.
The client GUI can be run as a stand-alone application or as a JConsole
plug-in.
[NOTE]
diff --git a/src/site/antora/modules/ROOT/pages/manual/appenders.adoc
b/src/site/antora/modules/ROOT/pages/manual/appenders.adoc
index 8d01cbc73a..59d2ad03f9 100644
--- a/src/site/antora/modules/ROOT/pages/manual/appenders.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/appenders.adoc
@@ -1671,7 +1671,9 @@ Each log event is sent as a Kafka record.
|syncSend
|boolean
-|The default is `true`, causing sends to block until the record has been
acknowledged by the Kafka server. When set to `false`, sends a return
immediately, allowing for lower latency and significantly higher throughput.
_New since 2.8. Be aware that this is a new addition, and it has not been
extensively tested. Any failure sending to Kafka will be reported as an error
to StatusLogger and the log event will be dropped (the ignoreExceptions
parameter will not be effective). Log events may [...]
+|The default is `true`, causing sends to block until the record has been
acknowledged by the Kafka server. When set to `false`, sends a return
immediately, allowing for lower latency and significantly higher throughput.
_New since 2.8. Be aware that this is a new addition, and it has not been
extensively tested.
+Any failure sending to Kafka will be reported as an error to
xref:manual/status-logger.adoc[] and the log event will be dropped (the
ignoreExceptions parameter will not be effective).
+Log events may arrive out of order on the Kafka server._
|properties
|Property[]
@@ -2925,7 +2927,7 @@ default is 1, meaning only the files in the specified
base directory.
false.
|testMode |boolean |If true, files are not deleted but instead a message
-is printed to the xref:manual/configuration.adoc#StatusMessages[status logger]
+is printed to the xref:manual/status-logger.adoc[]
at INFO level. Use this to do a dry run to test if the configuration
works as expected. The default is false.
@@ -3170,7 +3172,7 @@ the paths in the `pathList`.
under the base path up to the specified max depth, sorted most recently
modified files first. The script is free to modify and return this list.
-|statusLogger |StatusLogger |The StatusLogger that can be used to log
+|statusLogger |StatusLogger |The xref:manual/status-logger.adoc[] that can be
used to log
internal events during script execution.
|configuration |Configuration |The Configuration that owns this
diff --git a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
index e4d3e6a891..8aff3a4281 100644
--- a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
@@ -59,7 +59,7 @@ Upon initialization of a new logger context, Log4j assigns it
a context name and
. Files named `log4j2-test.<extension>`,
. Files named `log4j2<contextName>.<extension>`
. Files named `log4j2.<extension>`,
-. If no configuration file is found, Log4j uses the
link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/DefaultConfiguration[DefaultConfiguration],
and xref:manual/status-logger.adoc[the status logger] prints a warning.
+. If no configuration file is found, Log4j uses the
link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/DefaultConfiguration[DefaultConfiguration],
and xref:manual/status-logger.adoc[] prints a warning.
The default configuration prints all messages less specific than
xref:manual/systemproperties.adoc#log4j2.level[log4j2.level]
to the console.
@@ -422,11 +422,12 @@ To modify these options during a reconfiguration, you
also need to change the re
| Default value (before 2.24.0) | value of `log4j2.defaultStatusLevel`
|===
-Overrides the logging level of the status logger.
+Overrides the logging level of xref:manual/status-logger.adoc[].
-WARNING: Since version `2.24.0` this attribute is deprecated and should be
replaced with the
-xref:manual/systemproperties.adoc#log4j2.statusLoggerLevel[log4j2.statusLoggerLevel]
-configuration property.
+[WARNING]
+====
+Since version `2.24.0`, this attribute is deprecated and should be replaced
with the
xref:manual/systemproperties.adoc#log4j2.statusLoggerLevel[log4j2.statusLoggerLevel]
configuration property instead.
+====
[id=configuration-elements-filters]
==== Filters
diff --git a/src/site/antora/modules/ROOT/pages/manual/jmx.adoc
b/src/site/antora/modules/ROOT/pages/manual/jmx.adoc
index c2acf54730..8795690d13 100644
--- a/src/site/antora/modules/ROOT/pages/manual/jmx.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/jmx.adoc
@@ -18,10 +18,10 @@
Log4j 2 has built-in support for JMX.
-When JMX support is enabled, the StatusLogger, ContextSelector, and all
LoggerContexts, LoggerConfigs, and Appenders are instrumented with MBeans.
+When JMX support is enabled, xref:manual/status-logger.adoc[],
ContextSelector, and all LoggerContexts, LoggerConfigs, and
xref:manual/appenders.adoc[] are instrumented with MBeans.
Also included is a simple client GUI that can be used to monitor the
-StatusLogger output, as well as to remotely reconfigure Log4j with a
+status logger output, as well as to remotely reconfigure Log4j with a
different configuration file, or to edit the current configuration
directly.
diff --git a/src/site/antora/modules/ROOT/pages/manual/logsep.adoc
b/src/site/antora/modules/ROOT/pages/manual/logsep.adoc
index c471eee992..c2a12d4c0f 100644
--- a/src/site/antora/modules/ROOT/pages/manual/logsep.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/logsep.adoc
@@ -102,7 +102,7 @@ default ClassLoaderContextSelector.
See the instructions shared in xref:manual/webapp.adoc[Log4j Web].
Each application can be configured to share the same
configuration used at the container or can be individually configured.
-If status logging is set to debug in the configuration there will be
+If xref:manual/status-logger.adoc[status logging] is set to debug in the
configuration there will be
output from when logging is initialized in the container and then again
in each web application.
diff --git a/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
b/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
index 4d97bb2983..a50e7222d9 100644
--- a/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
@@ -115,7 +115,7 @@ interface if they support compiling their scripts.
Beanshell does extend the `Compilable` interface, but an attempt to compile a
script ends up in an
https://docs.oracle.com/javase/{java-target-version}/docs/api/java/lang/Error.html[Error]
being thrown.
-Log4j catches the throwable, but issues a warning in the status logger.
+Log4j catches the throwable, but issues a warning in
xref:manual/status-logger.adoc[].
----
2015-09-27 16:13:23,095 main DEBUG Script BeanShellSelector is compilable
diff --git a/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
b/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
index 75f071708c..6dff6b36e2 100644
--- a/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
@@ -91,7 +91,7 @@
include::partial$manual/systemproperties/properties-provider.adoc[leveloffset=+2
[id=properties-status-logger]
=== Status Logger
-NOTE: To configure status logger you can also place its configuration in a
file named `log4j2.StatusLogger.properties`.
+NOTE: To configure xref:manual/status-logger.adoc[] you can also place its
configuration in a file named `log4j2.StatusLogger.properties`.
Log4j contains an internal logging mechanism called `StatusLogger` that is
used by all Log4j components.
By default, the status logger only reports errors on the standard error
stream, but you can configure it using the following properties.
@@ -101,9 +101,9 @@
include::partial$manual/systemproperties/properties-status-logger.adoc[leveloffs
[id=properties-simple-logger]
=== Simple logger
-NOTE: To configure simple logger you can also place its configuration in a
file named `log4j2.simplelog.properties`.
+NOTE: To configure xref:manual/simple-logger.adoc[] you can also place its
configuration in a file named `log4j2.simplelog.properties`.
-The simple logger implementation contained in `log4j-api` can be configured
using these properties:
+The xref:manual/simple-logger.adoc[] implementation contained in `log4j-api`
can be configured using these properties:
include::partial$manual/systemproperties/properties-simple-logger.adoc[leveloffset=+2]
@@ -114,7 +114,7 @@ The behavior of the `ThreadContext` class can be fine-tuned
using the following
[WARNING]
====
-These configuration properties are only used by the Log4j Core and Simple
Logger implementations of Log4j API.
+These configuration properties are only used by the Log4j Core and
xref:manual/simple-logger.adoc[] implementations of Log4j API.
The `log4j-to-slf4j` logging bridge delegates `ThreadContext` calls to the
SLF4J https://slf4j.org/api/org/slf4j/MDC.html[MDC] class.
@@ -206,7 +206,7 @@
include::partial$manual/systemproperties/properties-jndi.adoc[leveloffset=+2]
[id=properties-log4j-core-thread-context]
=== Thread context (Log4j Core)
-Log4j Core supports the same properties as Simple Logger for the configuration
of the thread context.
+Log4j Core supports the same properties as xref:manual/simple-logger.adoc[]
for the configuration of the thread context.
See <<properties-simple-logger-thread-context>> for more details.
[id=properties-transport-security]
diff --git
a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
index c0b736ee4e..bfc5f4872f 100644
---
a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
+++
b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
@@ -207,7 +207,7 @@ Fully qualified class name of a
link:../javadoc/log4j-api/org/apache/logging/log
| Default value | `false`
|===
-Prints a stacktrace to the
xref:manual/configuration.adoc#StatusMessages[status logger] at `DEBUG` level
when the LoggerContext is started.
+Prints a stacktrace to the xref:manual/status-logger.adoc[] at `DEBUG` level
when the `LoggerContext` is started.
For debug purposes only.
diff --git
a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-provider.adoc
b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-provider.adoc
index bd30c61d86..02b2ea475b 100644
---
a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-provider.adoc
+++
b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-provider.adoc
@@ -28,7 +28,7 @@
Fully qualified class name of the Log4j API
link:../javadoc/log4j-api/org/apache/logging/log4j/spi/Provider[Provider] to
use.
By default, Log4j uses
https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html[ServiceLoader]
to select the provider to use.
-In case multiple providers are found on the classpath the provider with the
highest priority is selected and a `WARN` message is logger by the status
logger.
+In case multiple providers are found on the classpath the provider with the
highest priority is selected and a `WARN` message is logger by
xref:manual/status-logger.adoc[].
[id=log4j2.loggerContextFactory]
== `log4j2.loggerContextFactory`
