You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gi...@apache.org on 2024/07/08 11:15:45 UTC
(logging-log4j2) branch 2.x-site-stg-out updated: Add website content generated from `9d7cc367e53263453d0698615f8292c14414ec6f`
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch 2.x-site-stg-out
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x-site-stg-out by this push:
new 8143896b8d Add website content generated from `9d7cc367e53263453d0698615f8292c14414ec6f`
8143896b8d is described below
commit 8143896b8dc8c8c9b32309b92f220c4c1cd9eec9
Author: ASF Logging Services RM <pr...@logging.apache.org>
AuthorDate: Mon Jul 8 11:15:40 2024 +0000
Add website content generated from `9d7cc367e53263453d0698615f8292c14414ec6f`
---
.htaccess | 1 +
_images/DockerFluentd.png | Bin 16444 -> 0 bytes
_images/DockerFluentdAggregator.png | Bin 15394 -> 0 bytes
_images/DockerLogFile.png | Bin 14674 -> 0 bytes
_images/DockerStdout.png | Bin 19551 -> 0 bytes
_images/DockerTCP.png | Bin 11895 -> 0 bytes
_images/LoggerAggregator.png | Bin 11342 -> 0 bytes
development.html | 4 +-
download.html | 4 +-
faq.html | 4 +-
hibernate.html | 4 +-
index.html | 4 +-
javadoc.html | 4 +-
log4j-cassandra.html | 4 +-
log4j-couchdb.html | 4 +-
log4j-docker.html | 79 ++-
log4j-flume-ng.html | 4 +-
log4j-iostreams.html | 4 +-
log4j-jul.html | 4 +-
log4j-spring-boot.html | 4 +-
log4j-spring-cloud-config-client.html | 4 +-
log4j-spring-cloud-config.html | 4 +-
log4j-to-jul.html | 4 +-
manual/api.html | 4 +-
manual/appenders.html | 4 +-
manual/architecture.html | 4 +-
manual/async.html | 4 +-
manual/cloud.html | 1050 ++++++++++-----------------------
manual/compatibility.html | 4 +-
manual/config-intro.html | 4 +-
manual/configuration.html | 4 +-
manual/customconfig.html | 4 +-
manual/customloglevels.html | 4 +-
manual/eventlogging.html | 4 +-
manual/extending.html | 4 +-
manual/filters.html | 4 +-
manual/flowtracing.html | 4 +-
manual/garbagefree.html | 4 +-
manual/getting-started.html | 4 +-
manual/index.html | 4 +-
manual/installation.html | 6 +-
manual/jmx.html | 4 +-
manual/json-template-layout.html | 4 +-
manual/layouts.html | 4 +-
manual/logbuilder.html | 4 +-
manual/logsep.html | 4 +-
manual/lookups.html | 81 +--
manual/markers.html | 4 +-
manual/messages.html | 4 +-
manual/migration.html | 4 +-
manual/pattern-layout.html | 4 +-
manual/performance.html | 4 +-
manual/plugins.html | 4 +-
manual/resource-logger.html | 4 +-
manual/scoped-context.html | 4 +-
manual/scripts.html | 4 +-
manual/simple-logger.html | 4 +-
manual/status-logger.html | 4 +-
manual/systemproperties.html | 4 +-
manual/thread-context.html | 4 +-
manual/webapp.html | 4 +-
migrate-from-logback.html | 4 +-
migrate-from-slf4j.html | 4 +-
plugin-reference.html | 16 +-
release-notes.html | 16 +-
sitemap.xml | 116 ++--
66 files changed, 595 insertions(+), 978 deletions(-)
diff --git a/.htaccess b/.htaccess
index 3787ea1b64..b40af8fb96 100644
--- a/.htaccess
+++ b/.htaccess
@@ -42,6 +42,7 @@ RewriteRule "^log4j(-jakarta)?-web(/index)?\.html$" "manual/webapp.html" [R=perm
RewriteRule "^log4j-jcl(/index)?\.html$" "manual/installation.html#impl-core-bridge-jcl" [R=permanent,NE]
RewriteRule "^log4j-jmx-gui(/index)?\.html$" "/log4j/jmx-gui/latest/index.html" [R=permanent]
RewriteRule "^log4j-jpl(/index)?\.html$" "manual/installation.html#impl-core-bridge-jpl" [R=permanent,NE]
+RewriteRule "^log4j-kubernetes(/index)?\.html$" "https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md" [R=permanent]
RewriteRule "^log4j-mongodb3(/index)?\.html$" "manual/appenders.html#NoSQLAppenderMongoDB" [R=permanent,NE]
RewriteRule "^log4j-mongodb4(/index)?\.html$" "manual/appenders.html#log4j-mongodb4" [R=permanent,NE]
RewriteRule "^log4j-slf4j2?-impl(/index)?\.html$" "manual/installation.html#impl-core-bridge-slf4j" [R=permanent,NE]
diff --git a/_images/DockerFluentd.png b/_images/DockerFluentd.png
deleted file mode 100644
index edcd35082b..0000000000
Binary files a/_images/DockerFluentd.png and /dev/null differ
diff --git a/_images/DockerFluentdAggregator.png b/_images/DockerFluentdAggregator.png
deleted file mode 100644
index 846c5a677f..0000000000
Binary files a/_images/DockerFluentdAggregator.png and /dev/null differ
diff --git a/_images/DockerLogFile.png b/_images/DockerLogFile.png
deleted file mode 100644
index 5ec366ed74..0000000000
Binary files a/_images/DockerLogFile.png and /dev/null differ
diff --git a/_images/DockerStdout.png b/_images/DockerStdout.png
deleted file mode 100644
index 546e8969aa..0000000000
Binary files a/_images/DockerStdout.png and /dev/null differ
diff --git a/_images/DockerTCP.png b/_images/DockerTCP.png
deleted file mode 100644
index 4a30200c02..0000000000
Binary files a/_images/DockerTCP.png and /dev/null differ
diff --git a/_images/LoggerAggregator.png b/_images/LoggerAggregator.png
deleted file mode 100644
index 78ebf0af87..0000000000
Binary files a/_images/LoggerAggregator.png and /dev/null differ
diff --git a/development.html b/development.html
index af760ca2d5..79f261723a 100644
--- a/development.html
+++ b/development.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/download.html b/download.html
index d003ac3448..831b2626a5 100644
--- a/download.html
+++ b/download.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/faq.html b/faq.html
index 5ca7693132..c04ca06fa6 100644
--- a/faq.html
+++ b/faq.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/hibernate.html b/hibernate.html
index 245c33c1a5..0f17351521 100644
--- a/hibernate.html
+++ b/hibernate.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/index.html b/index.html
index 7980e87f65..fcdce2c06a 100644
--- a/index.html
+++ b/index.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/javadoc.html b/javadoc.html
index 8e24ace1d6..ea1acb7266 100644
--- a/javadoc.html
+++ b/javadoc.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-cassandra.html b/log4j-cassandra.html
index 52163798f4..ef152152dd 100644
--- a/log4j-cassandra.html
+++ b/log4j-cassandra.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-couchdb.html b/log4j-couchdb.html
index 53bea8f3dd..6545a186ef 100644
--- a/log4j-couchdb.html
+++ b/log4j-couchdb.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-docker.html b/log4j-docker.html
index db858aa489..e95a90d220 100644
--- a/log4j-docker.html
+++ b/log4j-docker.html
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <title>Log4j Docker Support :: Apache Log4j</title>
+ <title>Log4j Docker :: Apache Log4j</title>
<link rel="canonical" href="https://logging.apache.org/log4j/2.x/log4j-docker.html">
<meta name="generator" content="Antora 3.2.0-alpha.4">
<link rel="stylesheet" href="./_/css/site.css">
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
@@ -331,7 +331,7 @@
<ul>
<li><a href="index.html">Home</a></li>
<li>Components</li>
- <li><a href="log4j-docker.html">Log4j Docker Support</a></li>
+ <li><a href="log4j-docker.html">Log4j Docker</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/apache/logging-log4j2/edit/2.x/src/site/antora/modules/ROOT/pages/log4j-docker.adoc">Edit this Page</a></div>
@@ -341,64 +341,61 @@
<div class="toc-menu"></div>
</aside>
<article class="doc">
-<h1 class="page">Log4j Docker Support</h1>
+<h1 class="page">Log4j Docker</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>Log4j supports Docker by providing a Lookup to retrieve container information.</p>
+<p>Log4j Docker module offers <a href="https://docker.com">Docker</a>-specific utilities.</p>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="_accessing_docker"><a class="anchor" href="#_accessing_docker"></a>Accessing Docker</h2>
+<h2 id="install"><a class="anchor" href="#install"></a>Installation</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>The Log4j Docker support requires access to the Docker REST interface.
-In practical terms this means the application either needs access to unix:///var/run/docker.sock through a volume mount (not recommended), bind Docker to another host/port or unix socket.
-or use a proxy application to provide access.
-The <a href="https://github.com/apache/logging-log4j2/tree/main/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-application">Log4j Spring Cloud sample application</a> uses a socat proxy to access Docker.</p>
+<p>You need to add the following additional runtime dependency to your build to use Log4j Docker:</p>
</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_lookup_attributes"><a class="anchor" href="#_lookup_attributes"></a>Lookup Attributes</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Log4j Docker provides access to the following container attributes:</p>
-</div>
-<div class="ulist">
+<div id="_tabs_1" class="openblock tabs is-sync is-loading">
+<div class="content">
+<div class="ulist tablist">
<ul>
-<li>
-<p>containerId - The full id assigned to the container.</p>
-</li>
-<li>
-<p>containerName - The name assigned to the container.</p>
-</li>
-<li>
-<p>imageId - The id assigned to the image.</p>
-</li>
-<li>
-<p>imageName - The name assigned to the image.</p>
+<li id="_tabs_1_maven" class="tab">
+<p>Maven</p>
</li>
-<li>
-<p>shortContainerId - The first 12 characters of the container id.</p>
-</li>
-<li>
-<p>shortImageId - The first 12 characters of the image id.</p>
+<li id="_tabs_1_gradle" class="tab">
+<p>Gradle</p>
</li>
</ul>
</div>
-<div class="paragraph">
-<p>Attributes may be accessed by adding <code>${docker:containerId}</code> to the configuration.
-Note that docker variables are only resolved once during logging initialization so they shouldn’t be referenced with more than one <code>$</code> character.</p>
+<div id="_tabs_1_maven--panel" class="tabpanel" aria-labelledby="_tabs_1_maven">
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-docker</artifactId>
+ <version>2.23.1</version>
+ <scope>runtime</scope>
+</dependency></code></pre>
+</div>
+</div>
+</div>
+<div id="_tabs_1_gradle--panel" class="tabpanel" aria-labelledby="_tabs_1_gradle">
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">runtimeOnly 'org.apache.logging.log4j:log4j-docker:2.23.1'</code></pre>
+</div>
+</div>
+</div>
+</div>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="_requirements"><a class="anchor" href="#_requirements"></a>Requirements</h2>
+<h2 id="features"><a class="anchor" href="#features"></a>Features</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Log4j Docker requires Log4j Core, Log4j API and a minimum of Java 8.</p>
+<p>Log4j Docker provides <a href="manual/lookups.html#DockerLookup" class="xref page">Docker Lookup</a> that queries <a href="https://docs.docker.com/engine/api/">the API of the Docker Engine</a> running your container.
+You can use it to inject Docker-environment specific values (container ID, image name, etc.) in <a href="manual/configuration.html#property-substitution" class="xref page">property substitutions</a>.</p>
</div>
</div>
</div>
diff --git a/log4j-flume-ng.html b/log4j-flume-ng.html
index 23deed13a8..4d50a8e0a6 100644
--- a/log4j-flume-ng.html
+++ b/log4j-flume-ng.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-iostreams.html b/log4j-iostreams.html
index b1670e5320..ecff90dce1 100644
--- a/log4j-iostreams.html
+++ b/log4j-iostreams.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-jul.html b/log4j-jul.html
index feb8f50f43..6389dccd3c 100644
--- a/log4j-jul.html
+++ b/log4j-jul.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-spring-boot.html b/log4j-spring-boot.html
index 671c46cc28..b4fc3feec7 100644
--- a/log4j-spring-boot.html
+++ b/log4j-spring-boot.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-spring-cloud-config-client.html b/log4j-spring-cloud-config-client.html
index 13eec396e3..aaf7891cd7 100644
--- a/log4j-spring-cloud-config-client.html
+++ b/log4j-spring-cloud-config-client.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-spring-cloud-config.html b/log4j-spring-cloud-config.html
index 4c45f2dac7..da90926064 100644
--- a/log4j-spring-cloud-config.html
+++ b/log4j-spring-cloud-config.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/log4j-to-jul.html b/log4j-to-jul.html
index b805c75309..61502a77f6 100644
--- a/log4j-to-jul.html
+++ b/log4j-to-jul.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/api.html b/manual/api.html
index 4fd9b8cfb6..599bef5b04 100644
--- a/manual/api.html
+++ b/manual/api.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/appenders.html b/manual/appenders.html
index ca87e61ed5..5c1104fbe5 100644
--- a/manual/appenders.html
+++ b/manual/appenders.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/architecture.html b/manual/architecture.html
index bae38d579c..b6baaceb91 100644
--- a/manual/architecture.html
+++ b/manual/architecture.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/async.html b/manual/async.html
index 152ebac0e1..44328c3e33 100644
--- a/manual/async.html
+++ b/manual/async.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/cloud.html b/manual/cloud.html
index c1a3cb2f76..11e2750b61 100644
--- a/manual/cloud.html
+++ b/manual/cloud.html
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <title>Using Log4j in Cloud Enabled Applications :: Apache Log4j</title>
+ <title>Integrating with service-oriented architectures :: Apache Log4j</title>
<link rel="canonical" href="https://logging.apache.org/log4j/2.x/manual/cloud.html">
<meta name="generator" content="Antora 3.2.0-alpha.4">
<link rel="stylesheet" href="../_/css/site.css">
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
@@ -331,7 +331,7 @@
<ul>
<li><a href="../index.html">Home</a></li>
<li>Resources</li>
- <li><a href="cloud.html">Using Log4j in Cloud Enabled Applications</a></li>
+ <li><a href="cloud.html">Integrating with service-oriented architectures</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/apache/logging-log4j2/edit/2.x/src/site/antora/modules/ROOT/pages/manual/cloud.adoc">Edit this Page</a></div>
@@ -341,314 +341,240 @@
<div class="toc-menu"></div>
</aside>
<article class="doc">
-<h1 class="page">Using Log4j in Cloud Enabled Applications</h1>
+<h1 class="page">Integrating with service-oriented architectures</h1>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>In this page we will share certain <a href="#best-practices">best practices</a> you can employ in your applications using Log4j Core to integrate them with service-oriented architectures.
+While doing so, we will also try to share guides on some popular scenarios.</p>
+</div>
+</div>
+</div>
<div class="sect1">
-<h2 id="_the_twelve_factor_application"><a class="anchor" href="#_the_twelve_factor_application"></a>The Twelve-Factor Application</h2>
+<h2 id="motivation"><a class="anchor" href="#motivation"></a>Motivation</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>The Logging Guidelines for <a href="https://12factor.net/logs">The Twelve-Factor App</a> state that all logs should be routed
-unbuffered to stdout. Since this is the least common denominator it is guaranteed to work for all applications. However,
-as with any set of general guidelines, choosing the least common denominator approach comes at a cost. Some of the costs
-in Java applications include:</p>
+<p>Most modern software is deployed in <a href="https://en.wikipedia.org/wiki/Service-oriented_architecture">service-oriented architectures</a>.
+This is a very broad domain and can be realized in an amazingly large number of ways.
+Nevertheless, they all redefine the notion of an application:</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
+<div class="ulist">
+<ul>
<li>
-<p>Java stack traces are multi-line log messages. The standard docker log driver cannot handle these properly. See
-<a href="https://github.com/moby/moby/issues/22920">Docker Issue #22920</a> which was closed with the message "Don’t Care".
-Solutions for this are to:</p>
-<div class="olist loweralpha">
-<ol class="loweralpha" type="a">
-<li>
-<p>Use a docker log driver that does support multi-line log message,</p>
+<p>Deployed in <strong>multiple instances</strong></p>
</li>
<li>
-<p>Use a logging format that does not produce multi-line messages,</p>
+<p>Situated in <strong>multiple locations</strong>; either in the same rack, or in different data centers located in different continents</p>
</li>
<li>
-<p>Log from Log4j directly to a logging forwarder or aggregator and bypass the docker logging driver.</p>
-</li>
-</ol>
-</div>
+<p>Hosted by <strong>multiple platforms</strong>; hardware, virtual machine, container, etc.</p>
</li>
<li>
-<p>When logging to stdout in Docker, log events pass through Java’s standard output handling which is then directed
-to the operating system so that the output can be piped into a file. The overhead of all this is measurably slower
-than just writing directly to a file as can be seen in these benchmark results where logging
-to stdout is 16-20 times slower over repeated runs than logging directly to the file. The results below were obtained by
-running the <a href="https://github.com/apache/logging-log4j2/blob/release-2.x/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/OutputBenchmark.java">Output Benchmark</a>
-on a 2018 MacBook Pro with a 2.9GHz Intel Core i9 processor and a 1TB SSD. However, these results alone would not be
-enough to argue against writing to the standard output stream as they only amount to about 14-25 microseconds
-per logging call vs 1.5 microseconds when writing to the file.</p>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-none hljs"> Benchmark Mode Cnt Score Error Units
- OutputBenchmark.console thrpt 20 39291.885 ± 3370.066 ops/s
- OutputBenchmark.file thrpt 20 654584.309 ± 59399.092 ops/s
- OutputBenchmark.redirect thrpt 20 70284.576 ± 7452.167 ops/s</code></pre>
-</div>
-</div>
+<p><strong>Polyglot</strong>; a product of multiple programming languages</p>
</li>
<li>
-<p>When performing audit logging using a framework such as log4j-audit guaranteed delivery of the audit events
-is required. Many of the options for writing the output, including writing to the standard output stream, do
-not guarantee delivery. In these cases the event must be delivered to a "forwarder" that acknowledges receipt
-only when it has placed the event in durable storage, such as what <a href="https://flume.apache.org/">Apache Flume</a> will do.</p>
+<p><strong>Scaled</strong> on demand; instances come and go in time</p>
</li>
-</ol>
+</ul>
</div>
+<div class="paragraph">
+<p>Naturally, logging systems also evolved to accommodate these needs.
+In particular, the old practice of <em>"monoliths writing logs to files rotated daily"</em> has changed in two major angles:</p>
</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Application delivers logs differently</dt>
+<dd>
+<p>Applications no longer write logs to files, but <a href="#structured-encoding">encode them structurally</a>, and deliver them to an external system centrally managed.
+Most of the time this is a <a href="#proxy">proxy</a> (a library, a sidecar container, etc.) that takes care of discovering the log storage system and determining the right external service to forward the logs to.</p>
+</dd>
+<dt class="hdlist1">Platform stores logs differently</dt>
+<dd>
+<p>There is no longer <code>/var/log/tomcat/catalina.out</code> combining all logs of a monolith.
+Instead, the software runs in multiple instances, each is implemented in a different language, and instances get scaled (i.e., new ones get started, old ones get stopped) on demand.
+To accommodate this, logs are persisted on a central storage system (Elasticsearch, Google Cloud Logging, etc.) that allows advanced navigation and filtering capabilities.</p>
+</dd>
+</dl>
</div>
-<div class="sect1">
-<h2 id="_logging_approaches"><a class="anchor" href="#_logging_approaches"></a>Logging Approaches</h2>
-<div class="sectionbody">
<div class="paragraph">
-<p>All the solutions discussed on this page are predicated with the idea that log files cannot permanently
-reside on the file system and that all log events should be routed to one or more log analysis tools that will
-be used for reporting and alerting. There are many ways to forward and collect events to be sent to the
-log analysis tools.</p>
+<p>Log4j Core not only adapts to this evolution, but also strives to provide the best in the class support for that.
+We will explore how to integrate Log4j with service-oriented architectures.</p>
</div>
-<div class="paragraph">
-<p>Note that any approach that bypasses Docker’s logging drivers requires Log4j’s
-<a href="https://logging.apache.org/log4j/2.x/manual/lookups.html#DockerLookup">Docker Lookup</a> to allow Docker attributes to be injected into the log events.</p>
</div>
-<div class="sect2">
-<h3 id="_logging_to_the_standard_output_stream"><a class="anchor" href="#_logging_to_the_standard_output_stream"></a>Logging to the Standard Output Stream</h3>
-<div class="paragraph">
-<p>As discussed above, this is the recommended 12-Factor approach for applications running in a docker container.
-The Log4j team does not recommend this approach for performance reasons.</p>
</div>
+<div class="sect1">
+<h2 id="best-practices"><a class="anchor" href="#best-practices"></a>Best practices</h2>
+<div class="sectionbody">
<div class="paragraph">
-<p><span class="image"><img src="../_images/DockerStdout.png" alt="Stdout" width="Application Logging to the Standard Output Stream"></span></p>
-</div>
+<p>Independent of the service-oriented architecture you choose, there are certain best practices we strongly encourage you to follow:</p>
</div>
<div class="sect2">
-<h3 id="_logging_to_the_standard_output_stream_with_the_docker_fluentd_logging_driver"><a class="anchor" href="#_logging_to_the_standard_output_stream_with_the_docker_fluentd_logging_driver"></a>Logging to the Standard Output Stream with the Docker Fluentd Logging Driver</h3>
+<h3 id="structured-encoding"><a class="anchor" href="#structured-encoding"></a>Encode logs using a structured layout</h3>
<div class="paragraph">
-<p>Docker provides alternate <a href="https://docs.docker.com/config/containers/logging/configure/">logging drivers</a>,
-such as <a href="https://docs.docker.com/config/containers/logging/fluentd/">fluentd</a>, that
-can be used to redirect the standard output stream to a log forwarder or log aggregator.</p>
+<p>We can’t emphasize it enough to not use anything, but a <a href="layouts.html#structured-logging" class="xref page">structured layout</a> to deliver your logs to an external system.
+We recommend <a href="json-template-layout.html" class="xref page">JSON Template Layout</a> for this purpose:</p>
</div>
-<div class="paragraph">
-<p>When routing to a log forwarder it is expected that the forwarder will have the same lifetime as the
-application. If the forwarder should fail the management tools would be expected to also terminate
-other containers dependent on the forwarder.</p>
+<div class="ulist">
+<ul>
+<li>
+<p>JSON Template Layout provides full customizability and contains several predefined layouts for popular log storage services.</p>
+</li>
+<li>
+<p>JSON is accepted by every log storage service.</p>
+</li>
+<li>
+<p>JSON is supported by logging frameworks in other languages.
+This makes it possible to agree on a common log format with non-Java applications.</p>
+</li>
+</ul>
</div>
-<div class="paragraph">
-<p><span class="image"><img src="../_images/DockerFluentd.png" alt="Docker Fluentbit" width="Logging via StdOut using the Docker Fluentd Logging Driver to Fluent-bit"></span></p>
</div>
+<div class="sect2">
+<h3 id="proxy"><a class="anchor" href="#proxy"></a>Use a proxy for writing logs</h3>
<div class="paragraph">
-<p>As an alternative the logging drivers could be configured to route events directly to a logging aggregator.
-This is generally not a good idea as the logging drivers only allow a single host and port to be configured.
-The docker documentation isn’t clear but infers that log events will be dropped when log events cannot be
-delivered so this method should not be used if a highly available solution is required.</p>
+<p>Most of the time it is not a good idea to write to the log storage system directly, but instead delegate that task to a proxy.
+This design decouples applications' log target and the log storage system and, as a result, effectively enables each to evolve independently and reliably (i.e., without downtime).
+For instance, this will allow the log storage system to scale or migrate to a new environment while proxies take care of necessary buffering and routing.</p>
</div>
<div class="paragraph">
-<p><span class="image"><img src="../_images/DockerFluentdAggregator.png" alt="Docker Fluentd" width="Logging via StdOut using the Docker Fluentd Logging Driver to Fluentd"></span></p>
+<p>This proxy can appear in many forms, for instance:</p>
</div>
-</div>
-<div class="sect2">
-<h3 id="_logging_to_a_file"><a class="anchor" href="#_logging_to_a_file"></a>Logging to a File</h3>
-<div class="paragraph">
-<p>While this is not the recommended 12-Factor approach, it performs very well.
-However, it requires that the application declares a volume where the log files will reside and then configures the log forwarder to tail those files.
-Care must also be taken to automatically manage the disk space used for the logs, which Log4j can perform via the "Delete" action on the <a href="appenders.html#RollingFileAppender" class="xref page">RollingFileAppender</a>.</p>
+<div class="ulist">
+<ul>
+<li>
+<p><strong>Console</strong> can act as a proxy.
+Logs written to console can be consumed by an external service.
+For example, <a href="https://12factor.net/logs">The Twelve-Factor App</a> and <a href="https://kubernetes.io/docs/concepts/cluster-administration/logging/">Kubernetes Logging Architecture</a> recommends this approach.</p>
+</li>
+<li>
+<p>A <strong>library</strong> can act as proxy.
+It can tap into the logging API and forward it to an external service.
+For instance, <a href="https://docs.datadoghq.com/logs/log_collection/java">Datadog’s Java Log Collector</a> uses this mechanism.</p>
+</li>
+<li>
+<p>An external <strong>service</strong> can act as a proxy, which applications can write logs to.
+For example, you can write to <a href="https://www.elastic.co/logstash">Logstash</a>, a <a href="https://kubernetes.io/docs/concepts/cluster-administration/logging/#sidecar-container-with-a-logging-agent">Kubernetes logging agent sidecar</a>, or a <a href="https://redis.io/glossary/redis-queue/">Redis queue</a> over a socket.</p>
+</li>
+</ul>
</div>
<div class="paragraph">
-<p><span class="image"><img src="../_images/DockerLogFile.png" alt="File" width="Logging to a File"></span></p>
+<p>What to use as a proxy depends on your deployment environment.
+You should consult to your colleagues if there is already an established logging proxy convention.
+Otherwise, we strongly encourage you to establish one in collaboration with your system administrators and architects.</p>
</div>
</div>
<div class="sect2">
-<h3 id="_sending_directly_to_a_log_forwarder_via_tcp"><a class="anchor" href="#_sending_directly_to_a_log_forwarder_via_tcp"></a>Sending Directly to a Log Forwarder via TCP</h3>
+<h3 id="appender"><a class="anchor" href="#appender"></a>Configure your appender correctly</h3>
<div class="paragraph">
-<p>Sending logs directly to a Log Forwarder is simple as it generally just requires that the forwarder’s host and port be configured on a SocketAppender with an appropriate layout.</p>
+<p>Once you decide on <a href="#proxy">the log proxy</a> to use, the choice of appender pretty much becomes self-evident.
+Nevertheless, there are some tips we recommend you to practice:</p>
</div>
-<div class="paragraph">
-<p><span class="image"><img src="../_images/DockerTCP.png" alt="TCP" width="Application Logging to a Forwarder via TCP"></span></p>
+<div class="ulist">
+<ul>
+<li>
+<p><strong>For writing to console</strong>, use a <a href="appenders.html#ConsoleAppender" class="xref page">Console Appender</a> and make sure to configure its <code>direct</code> attribute to <code>true</code> for the maximum efficiency.</p>
+</li>
+<li>
+<p><strong>For writing to an external service</strong>, use a <a href="appenders.html#SocketAppender" class="xref page">Socket Appender</a> and make sure to set the protocol to TCP and configure the null delimiter of the associated layout.
+For instance, see <a href="json-template-layout.html#plugin-attr-nullEventDelimiterEnabled" class="xref page">the <code>nullEventDelimiterEnabled</code> configuration attribute of JSON Template Layout</a>.</p>
+</li>
+</ul>
</div>
</div>
<div class="sect2">
-<h3 id="_sending_directly_to_a_log_aggregator_via_tcp"><a class="anchor" href="#_sending_directly_to_a_log_aggregator_via_tcp"></a>Sending Directly to a Log Aggregator via TCP</h3>
+<h3 id="file"><a class="anchor" href="#file"></a>Avoid writing to files</h3>
<div class="paragraph">
-<p>Similar to sending logs to a forwarder, logs can also be sent to a cluster of aggregators.
-However, setting this up is not as simple since, to be highly available, a cluster of aggregators must be used.
-However, the SocketAppender currently can only be configured with a single host and port.
-To allow for failover if the primary aggregator fails the SocketAppender must be enclosed in a <a href="appenders.html#FailoverAppender" class="xref page">FailoverAppender</a>, which would also have the secondary aggregator configured.
-Another option is to have the SocketAppender point to a highly available proxy that can forward to the Log Aggregator.</p>
+<p>As explained in <a href="#motivation">Motivation</a>, in a service-oriented architecture, log files are</p>
</div>
-<div class="paragraph">
-<p>If the log aggregator used is Apache Flume (or similar) the Appenders for these support
-being configured with a list of hosts and ports so high availability is not an issue.</p>
+<div class="ulist">
+<ul>
+<li>
+<p>Difficult to maintain – writable volumes must be mounted to the runtime (container, VM, etc.), rotated, and monitored for excessive usage</p>
+</li>
+<li>
+<p>Difficult to use – multiple files need to be manually combined while troubleshooting, no central navigation point</p>
+</li>
+<li>
+<p>Difficult to interoperate – each application needs to be individually configured to produce the same structured log output to enable interleaving of logs from multiple sources while troubleshooting distributed issues</p>
+</li>
+</ul>
</div>
<div class="paragraph">
-<p><span class="image"><img src="../_images/LoggerAggregator.png" alt="Aggregator" width="Application Logging to an Aggregator via TCP"></span></p>
-</div>
+<p>In short, <strong>we don’t recommend writing logs to files</strong>.</p>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="ELK"><a class="anchor" href="#ELK"></a>Logging using Elasticsearch, Logstash, and Kibana</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>There are various approaches with different trade-offs for ingesting logs into
-an ELK stack. Here we will briefly cover how one can forward Log4j generated
-events first to Logstash and then to Elasticsearch.</p>
-</div>
<div class="sect2">
-<h3 id="_log4j_configuration"><a class="anchor" href="#_log4j_configuration"></a>Log4j Configuration</h3>
-<div class="sect3">
-<h4 id="_jsontemplatelayout"><a class="anchor" href="#_jsontemplatelayout"></a>JsonTemplateLayout</h4>
+<h3 id="separate-config"><a class="anchor" href="#separate-config"></a>Separate logging configuration from the application</h3>
<div class="paragraph">
-<p>Log4j provides a multitude of JSON generating layouts. In particular, JSON
-Template Layout allows full schema
-customization and bundles ELK-specific layouts by default, which makes it a
-great fit for the bill. Using the EcsLayout template as shown below will generate data in Kibana where
-the message displayed exactly matches the message passed to Log4j and most of the event attributes, including
-any exceptions, are present as individual attributes that can be displayed. Note, however that stack traces
-will be formatted without newlines.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Socket name="Logstash"
- host="${sys:logstash.host}"
- port="12345"
- protocol="tcp"
- bufferedIo="true">
- <JsonTemplateLayout eventTemplateUri="classpath:EcsLayout.json">
- <EventTemplateAdditionalField key="containerId" value="${docker:containerId:-}"/>
- <EventTemplateAdditionalField key="application" value="${lower:${spring:spring.application.name:-spring}}"/>
- <EventTemplateAdditionalField key="kubernetes.serviceAccountName" value="${k8s:accountName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.containerId" value="${k8s:containerId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.containerName" value="${k8s:containerName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.host" value="${k8s:host:-}"/>
- <EventTemplateAdditionalField key="kubernetes.labels.app" value="${k8s:labels.app:-}"/>
- <EventTemplateAdditionalField key="kubernetes.labels.pod-template-hash" value="${k8s:labels.podTemplateHash:-}"/>
- <EventTemplateAdditionalField key="kubernetes.master_url" value="${k8s:masterUrl:-}"/>
- <EventTemplateAdditionalField key="kubernetes.namespaceId" value="${k8s:namespaceId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.namespaceName" value="${k8s:namespaceName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.podID" value="${k8s:podId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.podIP" value="${k8s:podIp:-}"/>
- <EventTemplateAdditionalField key="kubernetes.podName" value="${k8s:podName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.imageId" value="${k8s:imageId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.imageName" value="${k8s:imageName:-}"/>
- </JsonTemplateLayout>
-</Socket></code></pre>
-</div>
+<p>We strongly advise you to separate the logging configuration from the application and couple them in an environment-specific way.
+This will allow you to</p>
</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Address environment-specific configurations (e.g., logging verbosity needs of test and production can be different)</p>
+</li>
+<li>
+<p>Ensure Log4j configuration changes applies to all affected Log4j-using software without the need to manually update their Log4j configuration one by one</p>
+</li>
+</ul>
</div>
-<div class="sect3">
-<h4 id="_gelf_template"><a class="anchor" href="#_gelf_template"></a>Gelf Template</h4>
<div class="paragraph">
-<p>The JsonTemplateLayout can also be used to generate JSON that matches the GELF specification which can format
-the message attribute using a pattern in accordance with the PatternLayout. For example, the following
-template, named EnhancedGelf.json, can be used to generate GELF-compliant data that can be passed to Logstash.
-With this template the message attribute will include the thread id, level, specific ThreadContext attributes,
-the class name, method name, and line number as well as the message. If an exception is included it will also
-be included with newlines. This format follows very closely what you would see in a typical log file on disk
-using the PatternLayout but has the additional advantage of including the attributes as separate fields that
-can be queried.</p>
+<p>How to implement this separation pretty much depends on your setup.
+We will share some recommended approaches to give you an idea:</p>
</div>
-<div class="listingblock">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Choosing configuration files during deployment</dt>
+<dd>
+<div class="openblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
- "version": "1.1",
- "host": "${hostName}",
- "short_message": {
- "$resolver": "message",
- "stringified": true
- },
- "full_message": {
- "$resolver": "message",
- "pattern": "[%t] %-5p %X{requestId, sessionId, loginId, userId, ipAddress, corpAcctNumber} %C{1.}.%M:%L - %m",
- "stringified": true
- },
- "timestamp": {
- "$resolver": "timestamp",
- "epoch": {
- "unit": "secs"
- }
- },
- "level": {
- "$resolver": "level",
- "field": "severity",
- "severity": {
- "field": "code"
- }
- },
- "_logger": {
- "$resolver": "logger",
- "field": "name"
- },
- "_thread": {
- "$resolver": "thread",
- "field": "name"
- },
- "_mdc": {
- "$resolver": "mdc",
- "flatten": {
- "prefix": "_"
- },
- "stringified": true
- }
-}</code></pre>
-</div>
-</div>
<div class="paragraph">
-<p>The logging configuration to use this template would be</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Socket name="Elastic"
- host="\${sys:logstash.search.host}"
- port="12222"
- protocol="tcp"
- bufferedIo="true">
- <JsonTemplateLayout eventTemplateUri="classpath:EnhancedGelf.json" nullEventDelimiterEnabled="true">
- <EventTemplateAdditionalField key="containerId" value="${docker:containerId:-}"/>
- <EventTemplateAdditionalField key="application" value="${lower:${spring:spring.application.name:-spring}}"/>
- <EventTemplateAdditionalField key="kubernetes.serviceAccountName" value="${k8s:accountName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.containerId" value="${k8s:containerId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.containerName" value="${k8s:containerName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.host" value="${k8s:host:-}"/>
- <EventTemplateAdditionalField key="kubernetes.labels.app" value="${k8s:labels.app:-}"/>
- <EventTemplateAdditionalField key="kubernetes.labels.pod-template-hash" value="${k8s:labels.podTemplateHash:-}"/>
- <EventTemplateAdditionalField key="kubernetes.master_url" value="${k8s:masterUrl:-}"/>
- <EventTemplateAdditionalField key="kubernetes.namespaceId" value="${k8s:namespaceId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.namespaceName" value="${k8s:namespaceName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.podID" value="${k8s:podId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.podIP" value="${k8s:podIp:-}"/>
- <EventTemplateAdditionalField key="kubernetes.podName" value="${k8s:podName:-}"/>
- <EventTemplateAdditionalField key="kubernetes.imageId" value="${k8s:imageId:-}"/>
- <EventTemplateAdditionalField key="kubernetes.imageName" value="${k8s:imageName:-}"/>
- </JsonTemplateLayout>
-</Socket></code></pre>
+<p>Environment-specific <a href="configuration.html" class="xref page">Log4j configuration files</a> (<code>log4j2-common.xml</code>, <code>log4j2-local.xml</code>, <code>log4j2-test.xml</code>, <code>log4j2-prod.xml</code>, etc.) can be provided in one of following ways:</p>
</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Shipped with your software (i.e., accessible in the classpath)</p>
+</li>
+<li>
+<p>Served from an HTTP server</p>
+</li>
+<li>
+<p>A combination of the first two</p>
+</li>
+</ul>
</div>
<div class="paragraph">
-<p>The significant difference with this configuration from the first example is that it references the
-custom template and it specifies an event delimiter of a null character ('\0');</p>
+<p>Depending on the deployment environment, you can selectively activate a subset of them using <a href="systemproperties.html#log4j2.configurationFile" class="xref page">the <code>log4j2.configurationFile</code> configuration property</a>.</p>
</div>
-<div class="admonitionblock note">
+<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
-<i class="fa icon-note" title="Note"></i>
+<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
-The level being passed with the above template does not strictly conform to the GELF spec as the Level being passed is the Log4j Level NOT the Level defined in the GELF spec.
-However, testing has shown that Logstash, Elk, and Kibana are pretty tolerant of whatever data is passed to it.
+<div class="paragraph">
+<p>Spring Boot allows you to <a href="https://docs.spring.io/spring-boot/reference/features/logging.html">configure the underlying logging system</a>.
+Just like any other Spring Boot configuration, logging-related configuration also can be provided in multiple files split by profiles matching the environment: <code>application-common.yaml</code>, <code>application-local.yaml</code>, etc.
+<a href="https://docs.spring.io/spring-boot/reference/features/external-config.html">Spring Boot’s Externalized Configuration System</a> will automatically load these files depending on the active profile(s).</p>
+</div>
</td>
</tr>
</table>
</div>
</div>
-<div class="sect3">
-<h4 id="_custom_template"><a class="anchor" href="#_custom_template"></a>Custom Template</h4>
+</div>
+</dd>
+<dt class="hdlist1">Mounting configuration files during deployment</dt>
+<dd>
<div class="paragraph">
-<p>Another option is to use a custom template, possibly based on one of the standard templates. The template
-below is loosely based on ECS but a) adds the spring boot application name, b) formats the message
-using PatternLayout, formats Map Messages as event.data attributes while setting the event action based on
-any Marker included in the event, includes all the ThreadContext attributes.</p>
+<p>Many service-oriented deployment architectures offer solutions for environment-specific configuration storage; Kubernetes' <a href="https://kubernetes.io/docs/concepts/configuration/configmap/">ConfigMap</a>, HashiCorp’s <a href="https://developer.hashicorp.com/consul/docs/dynamic-app-config/kv">Consul</a>, etc.
+You can leverage these to store environment-specific Log4j configurations and mount them to the associated runtime (container, VM, etc.) at deployment.</p>
+</div>
+</dd>
+</dl>
</div>
<div class="admonitionblock note">
<table>
@@ -657,545 +583,225 @@ any Marker included in the event, includes all the ThreadContext attributes.</p>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-The Json Template Layout escapes control sequences so messages that contain '\n' will have those
-control sequences copied as "\n" into the text rather than converted to a newline character. This bypasses
-many problems that occur with Log Forwarders such as Filebeat and FluentBit/Fluentd. Kibana will correctly
-interpret these sequences as newlines and display them correctly. Also note that the message pattern does
-not contain a timestamp. Kibana will display the timestamp field in its own column so placing it in the
-message would be redundant.
-</td>
-</tr>
-</table>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
- "@timestamp": {
- "$resolver": "timestamp",
- "pattern": {
- "format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
- "timeZone": "UTC"
- }
- },
- "ecs.version": "1.11.0",
- "log.level": {
- "$resolver": "level",
- "field": "name"
- },
- "application": "\\${lower:\\${spring:spring.application.name}}",
- "short_message": {
- "$resolver": "message",
- "stringified": true
- },
- "message": {
- "$resolver": "pattern",
- "pattern": "[%t] %X{requestId, sessionId, loginId, userId, ipAddress, accountNumber} %C{1.}.%M:%L - %m%n"
- },
- "process.thread.name": {
- "$resolver": "thread",
- "field": "name"
- },
- "log.logger": {
- "$resolver": "logger",
- "field": "name"
- },
- "event.action": {
- "$resolver": "marker",
- "field": "name"
- },
- "event.data": {
- "$resolver": "map",
- "stringified": true
- },
- "labels": {
- "$resolver": "mdc",
- "flatten": true,
- "stringified": true
- },
- "tags": {
- "$resolver": "ndc"
- },
- "error.type": {
- "$resolver": "exception",
- "field": "className"
- },
- "error.message": {
- "$resolver": "exception",
- "field": "message"
- },
- "error.stack_trace": {
- "$resolver": "exception",
- "field": "stackTrace",
- "stackTrace": {
- "stringified": true
- }
- }
-}</code></pre>
-</div>
-</div>
<div class="paragraph">
-<p>Finally, the GelfLayout can be used to generate GELF compliant output. Unlike the JsonTemplateLayout it adheres closely to the GELF spec.</p>
+<p>Log4j Core can poll configuration files for changes (see <a href="configuration.html#configuration-attribute-monitorInterval" class="xref page">the <code>monitorInterval</code> attribute</a>) and reconfigure the associated logger context.
+You can leverage this mechanism to <strong>dynamically update the Log4j configuration at runtime</strong>.</p>
</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Socket name="Elastic" host="${sys:elastic.search.host}" port="12222" protocol="tcp" bufferedIo="true">
- <GelfLayout includeStackTrace="true" host="${hostName}" includeThreadContext="true" includeNullDelimiter="true"
- compressionType="OFF">
- <ThreadContextIncludes>requestId,sessionId,loginId,userId,ipAddress,callingHost</ThreadContextIncludes>
- <MessagePattern>%d [%t] %-5p %X{requestId, sessionId, loginId, userId, ipAddress} %C{1.}.%M:%L - %m%n</MessagePattern>
- <KeyValuePair key="containerId" value="${docker:containerId:-}"/>
- <KeyValuePair key="application" value="${lower:${spring:spring.application.name:-spring}}"/>
- <KeyValuePair key="kubernetes.serviceAccountName" value="${k8s:accountName:-}"/>
- <KeyValuePair key="kubernetes.containerId" value="${k8s:containerId:-}"/>
- <KeyValuePair key="kubernetes.containerName" value="${k8s:containerName:-}"/>
- <KeyValuePair key="kubernetes.host" value="${k8s:host:-}"/>
- <KeyValuePair key="kubernetes.labels.app" value="${k8s:labels.app:-}"/>
- <KeyValuePair key="kubernetes.labels.pod-template-hash" value="${k8s:labels.podTemplateHash:-}"/>
- <KeyValuePair key="kubernetes.master_url" value="${k8s:masterUrl:-}"/>
- <KeyValuePair key="kubernetes.namespaceId" value="${k8s:namespaceId:-}"/>
- <KeyValuePair key="kubernetes.namespaceName" value="${k8s:namespaceName:-}"/>
- <KeyValuePair key="kubernetes.podID" value="${k8s:podId:-}"/>
- <KeyValuePair key="kubernetes.podIP" value="${k8s:podIp:-}"/>
- <KeyValuePair key="kubernetes.podName" value="${k8s:podName:-}"/>
- <KeyValuePair key="kubernetes.imageId" value="${k8s:imageId:-}"/>
- <KeyValuePair key="kubernetes.imageName" value="${k8s:imageName:-}"/>
- </GelfLayout>
-</Socket></code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_logstash_configuration_with_gelf"><a class="anchor" href="#_logstash_configuration_with_gelf"></a>Logstash Configuration with Gelf</h4>
<div class="paragraph">
-<p>We will configure Logstash to listen on TCP port 12345 for payloads of type JSON and then forward these to (either console and/or) an Elasticsearch server.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-none hljs">input {
- tcp {
- port => 12345
- codec => "json"
- }
-}
-
-output {
- # Uncomment for debugging purposes.
- # stdout { codec => rubydebug }
-
- # Modify the hosts value to reflect where Elasticsearch is installed.
- elasticsearch {
- hosts => ["http://localhost:9200/"]
- index => "app-%{application}-%{+YYYY.MM.dd}"
- }
-}</code></pre>
+<p>You need to be careful with this mechanism to not shoot yourself in the foot.
+Imagine publishing an incorrect <code>log4j2.xml</code> and rendering the logging setup of your entire cluster useless in seconds.
+Coupling the configuration with the application at deployment and gradually deploying new configurations is a more reliable approach.</p>
</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_logstash_configuration_with_jsontemplatelayout"><a class="anchor" href="#_logstash_configuration_with_jsontemplatelayout"></a>Logstash Configuration with JsonTemplateLayout</h4>
-<div class="paragraph">
-<p>When using one of the GELF compliant formats, Logstash should be configured as:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-none hljs">gelf {
- host => "localhost"
- use_tcp => true
- use_udp => false
- port => 12222
- type => "gelf"
- }
- }
-
- filter {
- translate {
- field => "[level]"
- destination => "[levelName]"
- dictionary => {
- "0" => "EMERG"
- "1" => "ALERT"
- "2" => "CRITICAL"
- "3" => "ERROR"
- "4" => "WARN"
- "5" => "NOTICE"
- "6" => "INFO"
- "7" => "DEBUG"
- }
- }
- }
-
- output {
- elasticsearch {
- hosts => ["http://localhost:9200/"]
- index => "app-%{application}-%{+YYYY.MM.dd}"
- }
- }</code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_filebeat_configuration_with_jsontemplatelayout"><a class="anchor" href="#_filebeat_configuration_with_jsontemplatelayout"></a>Filebeat configuration with JsonTemplateLayout</h4>
-<div class="paragraph">
-<p>When using a JsonTemplateLayout that complies with ECS, Filebeat configuration is straightforward.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">filebeat.inputs:
-- type: log
- enabled: true
- json.keys_under_root: true
- paths:
- - /var/log/apps/*.log</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_kibana"><a class="anchor" href="#_kibana"></a>Kibana</h3>
-<div class="paragraph">
-<p>Using the EnhancedGelf template or the custom template, the above configurations will allow the message
-field to contain a fully formatted log event. The ThreadContext attributes, custom fields, thread name, etc., will all be available as attributes on each log event that can be used for filtering.</p>
+</td>
+</tr>
+</table>
</div>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="_managing_logging_configuration"><a class="anchor" href="#_managing_logging_configuration"></a>Managing Logging Configuration</h2>
+<h2 id="guides"><a class="anchor" href="#guides"></a>Guides</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Spring Boot provides another least common denominator approach to logging configuration.
-It will let you set the log level for various Loggers within an application which can be dynamically updated via REST endpoints provided by Spring.
-While this works in a lot of cases it does not support any of the more advanced filtering features of Log4j.
-For example, since it cannot add or modify any Filters other than the log level of a logger, changes cannot be made to allow all log events for a specific user or customer to temporarily be logged (see <a href="filters.html#DynamicThresholdFilter" class="xref page">DynamicThresholdFilter</a> or <a href="filters.html#ThreadContextMapFilter" class="xref page">ThreadContextMapFilter</a>) or any other kinds of changes to filters.
-Also, in a microservices, clustered environment it is quite likely that these changes will need to be propagated to multiple servers at the same time.
-Trying to achieve this via REST calls could be difficult.</p>
+<p>In this section, we will share guides on some popular integration scenarios.</p>
</div>
+<div class="sect2">
+<h3 id="docker"><a class="anchor" href="#docker"></a>Docker</h3>
<div class="paragraph">
-<p>Since its first release Log4j has supported reconfiguration through a file.
-Beginning with Log4j 2.12.0 Log4j also supports accessing the configuration via HTTP(S) and monitoring the file for changes by using the HTTP "If-Modified-Since" header.
-A patch has also been integrated into Spring Cloud Config starting with versions 2.0.3 and 2.1.1 for it to honor the If-Modified-Since header.
-In addition, the log4j-spring-cloud-config project will listen for update events published by Spring Cloud Bus and then verify that the configuration file has been modified, so polling via HTTP is not required.</p>
+<p>See <a href="../log4j-docker.html" class="xref page">Log4j Docker</a> for Docker-specific Log4j features, e.g., <a href="lookups.html#DockerLookup" class="xref page">Docker Lookup</a>.
+We also strongly advise you to check <a href="https://docs.docker.com/config/containers/logging/">the extensive logging integration</a> offered by Docker containers.</p>
</div>
-<div class="paragraph">
-<p>Log4j also supports composite configurations.
-A distributed application spread across microservices could share a common configuration file that could be used to control things like enabling debug logging for a specific user.</p>
</div>
+<div class="sect2">
+<h3 id="_kubernetes"><a class="anchor" href="#_kubernetes"></a>Kubernetes</h3>
<div class="paragraph">
-<p>While the standard Spring Boot REST endpoints to update logging will still work any changes made by those REST endpoints will be lost if Log4j reconfigures itself do to changes in the logging configuration file.</p>
+<p>Log4j Kubernetes (containing <a href="lookups.html#KubernetesLookup" class="xref page">Kubernetes Lookup</a>) is distributed as a part of Fabric8’s Kubernetes Client, refer to <a href="https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md">its website</a> for details.</p>
</div>
-<div class="paragraph">
-<p>Further information regarding integration of the log4j-spring-cloud-config-client can be found at Log4j Spring Cloud Config Client.</p>
</div>
<div class="sect2">
-<h3 id="_integration_with_spring_boot"><a class="anchor" href="#_integration_with_spring_boot"></a>Integration with Spring Boot</h3>
+<h3 id="ELK"><a class="anchor" href="#ELK"></a>Elasticsearch & Logstash</h3>
<div class="paragraph">
-<p>Log4j integrates with Spring Boot in two ways:</p>
+<p>Elasticsearch, Logstash, and Kibana (aka. <a href="https://www.elastic.co/elastic-stack/">ELK Stack</a>) is probably the most popular logging system solution.
+In this setup,</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
+<div class="ulist">
+<ul>
<li>
-<p>A Spring Lookup can be used to access the Spring application configuration from Log4j configuration files.</p>
+<p><a href="https://www.elastic.co/elasticsearch">Elasticsearch</a> is used for log storage</p>
</li>
<li>
-<p>Log4j will access the Spring configuration when trying to resolve Log4j system properties.</p>
+<p><a href="https://www.elastic.co/logstash">Logstash</a> is used for transformation and ingestion to Elasticsearch from multiple sources (file, socket, etc.)</p>
</li>
-</ol>
+<li>
+<p><a href="https://www.elastic.co/kibana">Kibana</a> is used as a web-based UI to query Elasticsearch</p>
+</li>
+</ul>
</div>
<div class="paragraph">
-<p>Both of these require that the log4j-spring-cloud-client jar is included in the application.</p>
+<p>To begin with, JSON is the de facto messaging format used across the entire <a href="https://www.elastic.co/platform">Elastic platform</a>.
+Hence, as stated earlier, <a href="#structured-encoding">we strongly advise you to configure a structured encoding</a>, i.e., <a href="json-template-layout.html" class="xref page">JSON Template Layout</a>.</p>
</div>
-</div>
-<div class="sect2">
-<h3 id="_integration_with_docker"><a class="anchor" href="#_integration_with_docker"></a>Integration with Docker</h3>
+<div class="sect3">
+<h4 id="logstash"><a class="anchor" href="#logstash"></a>Logstash as a proxy</h4>
<div class="paragraph">
-<p>Applications within a Docker container that log using a Docker logging driver can include special attributes in the formatted log event as described at <a href="https://docs.docker.com/config/containers/logging/log_tags/">Customize Log Driver Output</a>.
-Log4j provides similar functionality via the <a href="lookups.html#DockerLookup" class="xref page">Docker Lookup</a>.
-More information on Log4j’s Docker support may also be found at <a href="../log4j-docker.html" class="xref page">Log4j Docker</a>.</p>
-</div>
+<p>While using ELK stack, there are numerous ways you can write your application logs to Elasticsearch.
+<a href="#proxy">We advise you to always employ a proxy</a> while doing so.
+In particular, <strong>we recommend you to use Logstash</strong> for this purpose.
+In a modern software stack, the shape and accessibility of log varies greatly: some write to files (be it legacy or new systems), some doesn’t provide a structured encoding, etc.
+Logstash excels at ingesting from a wide range of sources, transforming them into the desired format, and writing them to Elasticsearch.</p>
</div>
-<div class="sect2">
-<h3 id="_integration_with_kubernetes"><a class="anchor" href="#_integration_with_kubernetes"></a>Integration with Kubernetes</h3>
<div class="paragraph">
-<p>Applications managed by Kubernetes can bypass the Docker/Kubernetes logging infrastructure and log directly to either a sidecar forwarder or a logging aggragator cluster while still including all the Kubernetes attributes by using the <a href="https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md">Kubernetes Log4j Lookup</a> maintained by the Fabric8 project.</p>
-</div>
-</div>
+<p>While setting up Logstash, we recommend you to use <a href="https://www.elastic.co/guide/en/logstash/current/plugins-inputs-tcp.html">TCP input plugin</a> in combination with <a href="https://www.elastic.co/guide/en/logstash/current/plugins-outputs-elasticsearch.html">Elasticsearch output plugin</a> to accept logs over a TCP socket and write them to Elasticsearch:</p>
</div>
+<div class="listingblock">
+<div class="title">An example <code>logstash.conf</code> snippet for accepting JSON-encoded log events over TCP and writing them to Elasticsearch</div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">input {
+ tcp { <i class="conum" data-value="1"></i><b>(1)</b>
+ port => 12345 <i class="conum" data-value="2"></i><b>(2)</b>
+ codec => "json" <i class="conum" data-value="3"></i><b>(3)</b>
+ }
+}
+
+output {
+
+ # stdout { codec => rubydebug } <i class="conum" data-value="4"></i><b>(4)</b>
+
+ # Modify the hosts value to reflect where Elasticsearch is installed.
+ elasticsearch { <i class="conum" data-value="5"></i><b>(5)</b>
+ hosts => ["http://localhost:9200/"] <i class="conum" data-value="6"></i><b>(6)</b>
+ index => "app-%{application}-%{+YYYYMMdd}" <i class="conum" data-value="7"></i><b>(7)</b>
+ }
+
+}</code></pre>
</div>
-<div class="sect1">
-<h2 id="_appender_performance"><a class="anchor" href="#_appender_performance"></a>Appender Performance</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>The numbers in the table below represent how much time in seconds was required for the application to call <code>logger.debug(...)</code> 100,000 times.
-These numbers only include the time taken to deliver to the specifically noted endpoint and many not include the actual time required before they are available for viewing.
-All measurements were performed on a MacBook Pro with a 2.9GHz Intel Core I9 processor with 6 physical and 12 logical cores, 32GB of 2400 MHz DDR4 RAM, and 1TB of Apple SSD storage.
-The VM used by Docker was managed by VMWare Fusion and had 4 CPUs and 2 GB of RAM.
-These number should be used for relative performance comparisons as the results on another system may vary considerably.</p>
</div>
-<div class="paragraph">
-<p>The sample application used can be found under the in <a href="https://github.com/apache/logging-log4j-samples">the Log4j samples source repository</a>.</p>
-</div>
-<table class="tableblock frame-all grid-all stretch">
-<colgroup>
-<col style="width: 20%;">
-<col style="width: 20%;">
-<col style="width: 20%;">
-<col style="width: 20%;">
-<col style="width: 20%;">
-</colgroup>
-<thead>
-<tr>
-<th class="tableblock halign-left valign-top">Test</th>
-<th class="tableblock halign-left valign-top">1 Thread</th>
-<th class="tableblock halign-left valign-top">2 Threads</th>
-<th class="tableblock halign-left valign-top">4 Threads</th>
-<th class="tableblock halign-left valign-top">8 Threads</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Flume Avro</p></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Batch Size 1 - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">49.11</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">46.54</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">46.70</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">44.92</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Batch Size 1 - RFC5424</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">48.30</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">45.79</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">46.31</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">45.50</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Batch Size 100 - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">6.33</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.87</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.57</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.84</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Batch Size 100 - RFC5424</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">6.08</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.69</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.22</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.11</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Batch Size 1000 - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">4.83</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.20</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.02</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.11</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Batch Size 1000 - RFC5424</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">4.70</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.40</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.37</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.37</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Flume Embedded</p></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- RFC5424</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.58</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.10</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.10</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.70</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">4.20</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.49</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.53</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.90</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Kafka Local JSON</p></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- sendSync true</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">58.46</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">38.55</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">19.59</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">19.01</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- sendSync false</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">9.8</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">10.8</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">12.23</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">11.36</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Console</p></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- JSON / Kubernetes</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.03</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.11</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.04</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.51</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.80</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.74</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.54</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.35</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Docker fluentd driver</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">10.65</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">9.92</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">10.42</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">10.27</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Rolling File</p></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-</tr>
+<div class="colist arabic">
+<table>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- RFC5424</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.65</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.94</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.22</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.55</p></td>
+<td><i class="conum" data-value="1"></i><b>1</b></td>
+<td>Using <a href="https://www.elastic.co/guide/en/logstash/current/plugins-inputs-tcp.html">TCP input plugin</a> to accept logs from</td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.90</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.95</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.57</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.94</p></td>
+<td><i class="conum" data-value="2"></i><b>2</b></td>
+<td>Setting the port Logstash will bind to accept TCP connections to 12345 – <strong>adapt the <code>port</code></strong> to your setup</td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">TCP - Fluent Bit - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.34</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.167</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">1.67</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.50</p></td>
+<td><i class="conum" data-value="3"></i><b>3</b></td>
+<td>Setting the payload encoding to JSON</td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Async Logger</p></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
-<td class="tableblock halign-left valign-top"></td>
+<td><i class="conum" data-value="4"></i><b>4</b></td>
+<td>Uncomment this while troubleshooting your Logstash configuration</td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- TCP - Fluent Bit - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.90</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.58</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.36</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.48</p></td>
+<td><i class="conum" data-value="5"></i><b>5</b></td>
+<td>Using <a href="https://www.elastic.co/guide/en/logstash/current/plugins-outputs-elasticsearch.html">Elasticsearch output plugin</a> to write logs to Elasticsearch</td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Console - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.83</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.57</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.55</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.61</p></td>
+<td><i class="conum" data-value="6"></i><b>6</b></td>
+<td>The list of Elasticsearch hosts to connect to</td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">- Flume Avro - 1000 - JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.76</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.37</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.45</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">0.68</p></td>
+<td><i class="conum" data-value="7"></i><b>7</b></td>
+<td>The name of the Elasticsearch index to write to</td>
</tr>
-</tbody>
</table>
+</div>
<div class="paragraph">
-<p>Notes:</p>
+<p>Refer to <a href="https://www.elastic.co/guide/en/logstash/current/configuration.html">the official documentation</a> for details on configuring a Logstash pipeline.</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Flume Avro - Buffering is controlled by the batch size. Each send is complete when the remote
-acknowledges the batch was written to its channel. These number seem to indicate Flume Avro could
-benefit from using a pool of RPCClients, at least for a batchSize of 1.</p>
-</li>
-<li>
-<p>Flume Embedded - This is essentially asynchronous as it writes to an in-memory buffer. It is
-unclear why the performance isn’t closer to the AsyncLogger results.</p>
-</li>
-<li>
-<p>Kafka was run in standalone mode on the same laptop as the application. See sendSync set to true
-requires waiting for an ack from Kafka for each log event.</p>
-</li>
-<li>
-<p>Console - System.out is redirected to a file by Docker. Testing shows that it would be much
-slower if it was writing to the terminal screen.</p>
+<div class="paragraph">
+<p>For the sake of completeness, see the following Log4j configuration to write to the TCP socket Logstash accepts input from:</p>
+</div>
+<div id="_tabs_1" class="openblock tabs is-sync is-loading">
+<div class="content">
+<div class="ulist tablist">
+<ul>
+<li id="_tabs_1_xml" class="tab">
+<p>XML</p>
</li>
-<li>
-<p>Rolling File - Test uses the default buffer size of 8K.</p>
+<li id="_tabs_1_json" class="tab">
+<p>JSON</p>
</li>
-<li>
-<p>TCP to Fluent Bit - The Socket Appender uses a default buffer size of 8K.</p>
+<li id="_tabs_1_yaml" class="tab">
+<p>YAML</p>
</li>
-<li>
-<p>Async Loggers - These all write to a circular buffer and return to the application. The actual
-I/O will take place on a separate thread. If writing the events is performed more slowly than
-events are being created eventually the buffer will fill up and logging will be performed at
-the same pace that log events are written.</p>
+<li id="_tabs_1_properties" class="tab">
+<p>Properties</p>
</li>
-</ol>
+</ul>
</div>
+<div id="_tabs_1_xml--panel" class="tabpanel" aria-labelledby="_tabs_1_xml">
+<div class="listingblock">
+<div class="title">Snippet from an example <a href="https://github.com/apache/logging-log4j2/tree/2.x/src/site/antora/modules/ROOT/examples/cloud/logstash/log4j2.xml"><code>log4j2.xml</code></a></div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Socket name="SOCKET" host="localhost" port="12345">
+ <JsonTemplateLayout nullEventDelimiterEnabled="true"/>
+</Socket></code></pre>
+</div>
+</div>
+</div>
+<div id="_tabs_1_json--panel" class="tabpanel" aria-labelledby="_tabs_1_json">
+<div class="listingblock">
+<div class="title">Snippet from an example <a href="https://github.com/apache/logging-log4j2/tree/2.x/src/site/antora/modules/ROOT/examples/cloud/logstash/log4j2.json"><code>log4j2.json</code></a></div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">"Socket": {
+ "name": "SOCKET",
+ "host": "localhost",
+ "port": 12345,
+ "JsonTemplateLayout": {
+ "nullEventDelimiterEnabled": true
+ }
+}</code></pre>
+</div>
+</div>
+</div>
+<div id="_tabs_1_yaml--panel" class="tabpanel" aria-labelledby="_tabs_1_yaml">
+<div class="listingblock">
+<div class="title">Snippet from an example <a href="https://github.com/apache/logging-log4j2/tree/2.x/src/site/antora/modules/ROOT/examples/cloud/logstash/log4j2.yaml"><code>log4j2.yaml</code></a></div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">Socket:
+ name: "SOCKET"
+ host: "localhost"
+ port: 12345
+ JsonTemplateLayout:
+ nullEventDelimiterEnabled: true</code></pre>
+</div>
+</div>
+</div>
+<div id="_tabs_1_properties--panel" class="tabpanel" aria-labelledby="_tabs_1_properties">
+<div class="listingblock">
+<div class="title">Snippet from an example <a href="https://github.com/apache/logging-log4j2/tree/2.x/src/site/antora/modules/ROOT/examples/cloud/logstash/log4j2.properties"><code>log4j2.properties</code></a></div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">appender.0.type = Socket
+appender.0.name = SOCKET
+appender.0.host = localhost
+appender.0.port = 12345
+appender.0.layout.type = JsonTemplateLayout
+appender.0.layout.nullEventDelimiterEnabled = true</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p><a href="#file">We don’t recommend writing logs to files</a>.
+If this is a necessity in your logging setup for some reason, we recommend you to check <a href="https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-overview.html">Filebeat</a>.
+It is a data shipper agent for forwarding logs to Logstash, Elasticsearch, etc.</p>
+</div>
+</td>
+</tr>
+</table>
</div>
</div>
-<div class="sect1">
-<h2 id="_logging_recommendations"><a class="anchor" href="#_logging_recommendations"></a>Logging Recommendations</h2>
-<div class="sectionbody">
-<div class="olist arabic">
-<ol class="arabic">
-<li>
-<p>Use asynchronous logging unless guaranteed delivery is absolutely required. As
-the performance numbers show, so long as the volume of logging is not high enough to fill up the
-circular buffer the overhead of logging will almost be unnoticeable to the application.</p>
-</li>
-<li>
-<p>If overall performance is a consideration or you require multiline events such as stack traces
-be processed properly then log via TCP to a companion container that acts as a log forwarder or directly
-to a log aggregator as shown above in <a href="#ELK">Logging with ELK</a>. Use the
-Log4j Docker Lookup to add the container information to each log event.</p>
-</li>
-<li>
-<p>Whenever guaranteed delivery is required use Flume Avro with a batch size of 1 or another Appender such
-as the Kafka Appender with syncSend set to true that only return control after the downstream agent
-acknowledges receipt of the event. Beware that using an Appender that writes each event individually should
-be kept to a minimum since it is much slower than sending buffered events.</p>
-</li>
-<li>
-<p>Logging to files within the container is discouraged. Doing so requires that a volume be declared in
-the Docker configuration and that the file be tailed by a log forwarder. However, it performs
-better than logging to the standard output stream. If logging via TCP is not an option and
-proper multiline handling is required then consider this option.</p>
-</li>
-</ol>
</div>
</div>
</div>
diff --git a/manual/compatibility.html b/manual/compatibility.html
index 70ea065cf1..41c35856e7 100644
--- a/manual/compatibility.html
+++ b/manual/compatibility.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/config-intro.html b/manual/config-intro.html
index 1426e47990..cd09fc4c12 100644
--- a/manual/config-intro.html
+++ b/manual/config-intro.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/configuration.html b/manual/configuration.html
index db2a4f2225..b017afb114 100644
--- a/manual/configuration.html
+++ b/manual/configuration.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/customconfig.html b/manual/customconfig.html
index 7eed9d290e..1b399a4f4d 100644
--- a/manual/customconfig.html
+++ b/manual/customconfig.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/customloglevels.html b/manual/customloglevels.html
index 9145feea49..67c5551bc4 100644
--- a/manual/customloglevels.html
+++ b/manual/customloglevels.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/eventlogging.html b/manual/eventlogging.html
index 72c3c1b3af..63b39c74e5 100644
--- a/manual/eventlogging.html
+++ b/manual/eventlogging.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/extending.html b/manual/extending.html
index 990ec880c5..56e40d4318 100644
--- a/manual/extending.html
+++ b/manual/extending.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/filters.html b/manual/filters.html
index 3aaea90813..597b658cf4 100644
--- a/manual/filters.html
+++ b/manual/filters.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/flowtracing.html b/manual/flowtracing.html
index a00974b7da..6fab2263b9 100644
--- a/manual/flowtracing.html
+++ b/manual/flowtracing.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/garbagefree.html b/manual/garbagefree.html
index 14bf942ecc..7118932156 100644
--- a/manual/garbagefree.html
+++ b/manual/garbagefree.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/getting-started.html b/manual/getting-started.html
index 151d673f46..1c62476214 100644
--- a/manual/getting-started.html
+++ b/manual/getting-started.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/index.html b/manual/index.html
index 1fcfc1683e..1ffa4b1873 100644
--- a/manual/index.html
+++ b/manual/index.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/installation.html b/manual/installation.html
index 2fe9d07123..47f5232a92 100644
--- a/manual/installation.html
+++ b/manual/installation.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
@@ -961,7 +961,7 @@ build tool:</p>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
- <version>1.3.2</version>
+ <version>1.3.3</version>
</dependency>
</dependencyManagement></code></pre>
</div>
diff --git a/manual/jmx.html b/manual/jmx.html
index 0ee2f296e6..21ab6c1e4c 100644
--- a/manual/jmx.html
+++ b/manual/jmx.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/json-template-layout.html b/manual/json-template-layout.html
index 8ada3a8227..43110ed879 100644
--- a/manual/json-template-layout.html
+++ b/manual/json-template-layout.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/layouts.html b/manual/layouts.html
index ccd9e2f4e3..69b191f465 100644
--- a/manual/layouts.html
+++ b/manual/layouts.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/logbuilder.html b/manual/logbuilder.html
index c2d6c244c4..18368908fe 100644
--- a/manual/logbuilder.html
+++ b/manual/logbuilder.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/logsep.html b/manual/logsep.html
index 4c49a2b4d0..4f434ecb27 100644
--- a/manual/logsep.html
+++ b/manual/logsep.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/lookups.html b/manual/lookups.html
index 007b9735e3..33d34eadb9 100644
--- a/manual/lookups.html
+++ b/manual/lookups.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
@@ -407,11 +407,25 @@ be formatted as specified.</p>
<div class="sect1">
<h2 id="DockerLookup"><a class="anchor" href="#DockerLookup"></a>Docker Lookup</h2>
<div class="sectionbody">
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 80%;">
+</colgroup>
+<tbody>
+<tr>
+<th class="tableblock halign-left valign-top"><p class="tableblock">Lookup ID</p></th>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>docker</code></p></td>
+</tr>
+<tr>
+<th class="tableblock halign-left valign-top"><p class="tableblock">Dependency</p></th>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../log4j-docker.html" class="xref page">Log4j Docker</a></p></td>
+</tr>
+</tbody>
+</table>
<div class="paragraph">
-<p>The DockerLookup can be used to lookup attributes from the Docker container the application is running in.</p>
-</div>
-<div class="paragraph">
-<p>Log4j Docker provides access to the following container attributes:</p>
+<p>Docker Lookup queries <a href="https://docs.docker.com/engine/api/">the API of the Docker Engine</a> running your container.
+It supports the retrieval of following container attributes:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
@@ -427,54 +441,30 @@ be formatted as specified.</p>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>containerId</code></p></td>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>The full id assigned to the container.</p>
-</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Container ID</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>containerName</code></p></td>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>The name assigned to the container.</p>
-</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Container name</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>imageId</code></p></td>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>The id assigned to the image.</p>
-</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Container image ID</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>imageName</code></p></td>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>The name assigned to the image.</p>
-</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Container image name</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>shortContainerId</code></p></td>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>The first 12 characters of the container id.</p>
-</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The first 12 characters of the container ID</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>shortImageId</code></p></td>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>The first 12 characters of the image id.</p>
-</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The first 12 characters of the container image ID</p></td>
</tr>
</tbody>
</table>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JsonTemplateLayout>
- <EventTemplateAdditionalField key="containerId" value="${docker:containerId}"/>
- <EventTemplateAdditionalField key="containerName" value="${docker:containerName}"/>
- <EventTemplateAdditionalField key="imageName" value="${docker:imageName}"/>
-</JsonTemplateLayout></code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>This Lookup is subject to the requirements listed at <a href="../log4j-docker.html" class="xref page">Log4j Docker Support</a></p>
-</div>
</div>
</div>
<div class="sect1">
@@ -771,8 +761,25 @@ acquire the JVM arguments.</p>
<div class="sect1">
<h2 id="KubernetesLookup"><a class="anchor" href="#KubernetesLookup"></a>Kubernetes Lookup</h2>
<div class="sectionbody">
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 80%;">
+</colgroup>
+<tbody>
+<tr>
+<th class="tableblock halign-left valign-top"><p class="tableblock">Lookup ID</p></th>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>k8s</code></p></td>
+</tr>
+<tr>
+<th class="tableblock halign-left valign-top"><p class="tableblock">Dependency</p></th>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md">Log4j Kubernetes of Fabric8</a></p></td>
+</tr>
+</tbody>
+</table>
<div class="paragraph">
-<p>For retrieving attributes using Fabric8’s Kubernetes Client, see their <a href="https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md">Kubernetes Log4j Lookup</a>.</p>
+<p>Kubernetes Lookup queries <a href="https://kubernetes.io/docs/concepts/overview/kubernetes-api/">the Kubernetes API</a> to retrieve certain information about the current container and its environment.
+Kubernetes Lookup is distributed as a part of Fabric8’s Kubernetes Client, refer to <a href="https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md">its website</a> for details.</p>
</div>
</div>
</div>
diff --git a/manual/markers.html b/manual/markers.html
index 2818c7cac5..2cab812904 100644
--- a/manual/markers.html
+++ b/manual/markers.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/messages.html b/manual/messages.html
index 01e3ae862b..36a3215a48 100644
--- a/manual/messages.html
+++ b/manual/messages.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/migration.html b/manual/migration.html
index 78eedbce75..1fd7d4c492 100644
--- a/manual/migration.html
+++ b/manual/migration.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/pattern-layout.html b/manual/pattern-layout.html
index c85428e318..c23278b980 100644
--- a/manual/pattern-layout.html
+++ b/manual/pattern-layout.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/performance.html b/manual/performance.html
index 0da3b5dc4c..410eb11006 100644
--- a/manual/performance.html
+++ b/manual/performance.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/plugins.html b/manual/plugins.html
index 9fec6c9c89..0823592738 100644
--- a/manual/plugins.html
+++ b/manual/plugins.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/resource-logger.html b/manual/resource-logger.html
index 8b2958f69b..b8bc462f12 100644
--- a/manual/resource-logger.html
+++ b/manual/resource-logger.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/scoped-context.html b/manual/scoped-context.html
index ee51b0e590..5c1e150eb7 100644
--- a/manual/scoped-context.html
+++ b/manual/scoped-context.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/scripts.html b/manual/scripts.html
index 33e4d306d1..94267dacad 100644
--- a/manual/scripts.html
+++ b/manual/scripts.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/simple-logger.html b/manual/simple-logger.html
index 5fff777065..3301a19507 100644
--- a/manual/simple-logger.html
+++ b/manual/simple-logger.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/status-logger.html b/manual/status-logger.html
index 249a1d5def..3143067e85 100644
--- a/manual/status-logger.html
+++ b/manual/status-logger.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/systemproperties.html b/manual/systemproperties.html
index e417fb2e7c..df34b84496 100644
--- a/manual/systemproperties.html
+++ b/manual/systemproperties.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/thread-context.html b/manual/thread-context.html
index df6956a0f6..b24b13223c 100644
--- a/manual/thread-context.html
+++ b/manual/thread-context.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/manual/webapp.html b/manual/webapp.html
index 1b18d6249c..eb6b76edef 100644
--- a/manual/webapp.html
+++ b/manual/webapp.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="../log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="../log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="../log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../log4j-flume-ng.html">Flume Appender</a>
diff --git a/migrate-from-logback.html b/migrate-from-logback.html
index 09d47d0d00..3458d0d1b0 100644
--- a/migrate-from-logback.html
+++ b/migrate-from-logback.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/migrate-from-slf4j.html b/migrate-from-slf4j.html
index 930bda1039..367b3e8c73 100644
--- a/migrate-from-slf4j.html
+++ b/migrate-from-slf4j.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
diff --git a/plugin-reference.html b/plugin-reference.html
index 39c760274b..c59376b8e9 100644
--- a/plugin-reference.html
+++ b/plugin-reference.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
@@ -16151,10 +16151,10 @@ Supports Lookup expressions.</p>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p>
+<p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p>
</div>
<div class="paragraph">
-<p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p>
+<p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p>
</div></div></td>
</tr>
<tr>
@@ -17450,10 +17450,10 @@ Supports Lookup expressions.</p>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p>
+<p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p>
</div>
<div class="paragraph">
-<p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p>
+<p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p>
</div></div></td>
</tr>
<tr>
@@ -17649,10 +17649,10 @@ Supports Lookup expressions.</p>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p>
+<p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p>
</div>
<div class="paragraph">
-<p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p>
+<p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p>
</div></div></td>
</tr>
<tr>
diff --git a/release-notes.html b/release-notes.html
index 1f3a8c26ba..117ce2c171 100644
--- a/release-notes.html
+++ b/release-notes.html
@@ -250,7 +250,7 @@
<a class="nav-link" href="manual/webapp.html">Using Log4j in a Jakarta EE environment</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="manual/cloud.html">Using Log4j in Cloud Enabled Applications</a>
+ <a class="nav-link" href="manual/cloud.html">Integrating with service-oriented architectures</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="development.html">Development</a>
@@ -268,7 +268,7 @@
<a class="nav-link" href="log4j-couchdb.html">CouchDB Appender</a>
</li>
<li class="nav-item" data-depth="1">
- <a class="nav-link" href="log4j-docker.html">Log4j Docker Support</a>
+ <a class="nav-link" href="log4j-docker.html">Log4j Docker</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="log4j-flume-ng.html">Flume Appender</a>
@@ -474,7 +474,7 @@
<p>Update <code>apache/logging-parent</code> to version `` (<a href="https://github.com/apache/logging-log4j2/pull/2597">2597</a>)</p>
</li>
<li>
-<p>Update <code>co.elastic.clients:elasticsearch-java</code> to version <code>8.14.1</code> (<a href="https://github.com/apache/logging-log4j2/pull/2657">2657</a>)</p>
+<p>Update <code>co.elastic.clients:elasticsearch-java</code> to version <code>8.14.2</code> (<a href="https://github.com/apache/logging-log4j2/pull/2711">2711</a>)</p>
</li>
<li>
<p>Update <code>com.fasterxml.jackson:jackson-bom</code> to version <code>2.17.1</code> (<a href="https://github.com/apache/logging-log4j2/pull/2570">2570</a>)</p>
@@ -495,7 +495,10 @@
<p>Update <code>commons-io:commons-io</code> to version <code>2.16.1</code> (<a href="https://github.com/apache/logging-log4j2/pull/2459">2459</a>)</p>
</li>
<li>
-<p>Update <code>commons-logging:commons-logging</code> to version <code>1.3.2</code> (<a href="https://github.com/apache/logging-log4j2/pull/2589">2589</a>)</p>
+<p>Update <code>commons-logging:commons-logging</code> to version <code>1.3.3</code> (<a href="https://github.com/apache/logging-log4j2/pull/2713">2713</a>)</p>
+</li>
+<li>
+<p>Update <code>de.flapdoodle.embed:de.flapdoodle.embed.mongo</code> to version <code>4.12.0</code> (<a href="https://github.com/apache/logging-log4j2/pull/2710">2710</a>)</p>
</li>
<li>
<p>Update <code>github/codeql-action</code> to version <code>3.25.1</code> (<a href="https://github.com/apache/logging-log4j2/pull/2483">2483</a>)</p>
@@ -504,7 +507,7 @@
<p>Update <code>io.netty:netty-bom</code> to version <code>4.1.111.Final</code> (<a href="https://github.com/apache/logging-log4j2/pull/2653">2653</a>)</p>
</li>
<li>
-<p>Update <code>net.javacrumbs.json-unit:json-unit</code> to version <code>2.39.0</code> (<a href="https://github.com/apache/logging-log4j2/pull/2701">2701</a>)</p>
+<p>Update <code>net.javacrumbs.json-unit:json-unit</code> to version <code>2.40.0</code> (<a href="https://github.com/apache/logging-log4j2/pull/2708">2708</a>)</p>
</li>
<li>
<p>Update <code>org.apache.activemq:activemq-broker</code> to version <code>6.1.2</code> (<a href="https://github.com/apache/logging-log4j2/pull/2472">2472</a>)</p>
@@ -543,6 +546,9 @@
<p>Update <code>org.codehaus.groovy:groovy-bom</code> to version <code>3.0.22</code> (<a href="https://github.com/apache/logging-log4j2/pull/2698">2698</a>)</p>
</li>
<li>
+<p>Update <code>org.eclipse.jetty:jetty-bom</code> to version <code>9.4.55.v20240627</code> (<a href="https://github.com/apache/logging-log4j2/pull/2709">2709</a>)</p>
+</li>
+<li>
<p>Update <code>org.eclipse.persistence:org.eclipse.persistence.jpa</code> to version `` (<a href="https://github.com/apache/logging-log4j2/pull/2602">2602</a>)</p>
</li>
<li>
diff --git a/sitemap.xml b/sitemap.xml
index f249bff144..cc4956522a 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -2,234 +2,234 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://logging.apache.org/log4j/2.x/development.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/download.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/faq.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/hibernate.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/index.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/javadoc.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-cassandra.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-couchdb.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-docker.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-flume-ng.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-iostreams.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-jul.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-spring-boot.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-spring-cloud-config-client.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-spring-cloud-config.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/log4j-to-jul.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/api.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/appenders.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/architecture.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/async.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/cloud.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/compatibility.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/config-intro.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/configuration.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/customconfig.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/customloglevels.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/eventlogging.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/extending.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/filters.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/flowtracing.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/garbagefree.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/getting-started.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/index.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/installation.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/jmx.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/json-template-layout.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/layouts.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/logbuilder.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/logsep.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/lookups.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/markers.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/messages.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/migration.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/pattern-layout.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/performance.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/plugins.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/resource-logger.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/scoped-context.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/scripts.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/simple-logger.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/status-logger.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/systemproperties.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/thread-context.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/manual/webapp.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/migrate-from-logback.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/migrate-from-slf4j.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/plugin-reference.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
<url>
<loc>https://logging.apache.org/log4j/2.x/release-notes.html</loc>
-<lastmod>2024-07-04T09:09:56.677Z</lastmod>
+<lastmod>2024-07-08T11:15:04.634Z</lastmod>
</url>
</urlset>