This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch 2.x-site-pro
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x-site-pro by this push:
new 42b42a0d6c Add "Simple Logger" API implementation
42b42a0d6c is described below
commit 42b42a0d6c60390215d7e51fa516e581cedad17a
Author: Piotr P. Karwasz <[email protected]>
AuthorDate: Mon Jan 27 13:28:45 2025 +0100
Add "Simple Logger" API implementation
---
.../modules/ROOT/pages/manual/installation.adoc | 29 ++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/src/site/antora/modules/ROOT/pages/manual/installation.adoc
b/src/site/antora/modules/ROOT/pages/manual/installation.adoc
index 91327a9a3b..9d93a52bf3 100644
--- a/src/site/antora/modules/ROOT/pages/manual/installation.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/installation.adoc
@@ -133,6 +133,11 @@ include::partial$components/log4j-api.adoc[]
Log4j provides several modules to facilitate the deployment of different
logging implementations:
+xref:manual/simple-logger.adoc[]::
+This is a fallback implementation embedded into the Log4j API artifact.
+The usage of this implementation generates an error message unless you enable
it explicitly.
+See <<impl-simple>> for more details.
+
`log4j-core`::
The reference implementation.
Log4 Core primarily accepts input from Log4j API.
@@ -169,6 +174,30 @@ h| Gradle
|===
====
+[#impl-simple]
+=== Installing Simple Logger
+
+The
+xref:manual/simple-logger.adoc[Simple Logger]
+implementation is embedded in the Log4j API and does not need any external
dependency.
+It is intended as a convenience for environments where either a fully-fledged
logging implementation is missing, or cannot be included for other reasons.
+The Log4j API will log an error to the
+xref:manual/status-logger.adoc[Status Logger] to avoid its unintentional
usages:
+
+----
+2024-10-03T11:53:34.281462230Z main ERROR Log4j API could not find a logging
provider.
+----
+
+To remove the warning and confirm that you want to use Simple Logger, add a
+xref:manual/systemproperties.adoc#property-sources[`log4j2.component.properties`
file]
+at the root of your class path with content:
+
+[source,properties]
+----
+# Activate Simple Logger implementation
+log4j.provider = org.apache.logging.log4j.simple.internal.SimpleProvider
+----
+
[#impl-core]
=== Installing Log4j Core
