Merge remote-tracking branch 'origin/2.x' into release/2.26.0

Author: vy

.github/workflows/build.yaml

@@ -30,21 +30,18 @@ permissions: read-all
 jobs:
 
   build:
-    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/12.1.1
-    secrets:
-      DV_ACCESS_TOKEN: ${{ startsWith(github.ref_name, 'release/') && '' || secrets.DEVELOCITY_ACCESS_KEY }}
+    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@gha/v0
     with:
       java-version: |
         8
         17
       site-enabled: true
       reproducibility-check-enabled: false
-      develocity-enabled: ${{ ! startsWith(github.ref_name, 'release/') }}
 
   deploy-snapshot:
     needs: build
     if: github.repository == 'apache/logging-log4j2' && github.ref_name == '2.x'
-    uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@gha/v0
     # Secrets for deployments
     secrets:
       NEXUS_USERNAME: ${{ secrets.NEXUS_USER }}
@@ -57,7 +54,7 @@ jobs:
   deploy-release:
     needs: build
     if: github.repository == 'apache/logging-log4j2' && startsWith(github.ref_name, 'release/')
-    uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@gha/v0
     # Secrets for deployments
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
@@ -78,7 +75,7 @@ jobs:
     needs: [ deploy-snapshot, deploy-release ]
     if: ${{ always() && (needs.deploy-snapshot.result == 'success' || needs.deploy-release.result == 'success') }}
     name: "verify-reproducibility (${{ needs.deploy-release.result == 'success' && needs.deploy-release.outputs.project-version || needs.deploy-snapshot.outputs.project-version }})"
-    uses: apache/logging-parent/.github/workflows/verify-reproducibility-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/verify-reproducibility-reusable.yaml@gha/v0
     with:
       nexus-url: ${{ needs.deploy-release.result == 'success' && needs.deploy-release.outputs.nexus-url || 'https://repository.apache.org/content/groups/snapshots' }}
       # Encode the `runs-on` input as JSON array

.github/workflows/codeql-analysis.yaml

@@ -30,7 +30,7 @@ permissions: read-all
 jobs:
 
   analyze:
-    uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@gha/v0
     with:
       java-version: |
         8

.github/workflows/deploy-site.yaml

@@ -33,7 +33,7 @@ jobs:
 
   deploy-site-stg:
     if: github.repository == 'apache/logging-log4j2' && github.ref_name == '2.x'
-    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@gha/v0
     # Secrets for committing the generated site
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
@@ -51,7 +51,7 @@ jobs:
 
   deploy-site-pro:
     if: github.repository == 'apache/logging-log4j2' && github.ref_name == '2.x-site-pro'
-    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@gha/v0
     # Secrets for committing the generated site
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
@@ -80,7 +80,7 @@ jobs:
 
   deploy-site-rel:
     needs: export-version
-    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/12.1.1
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@gha/v0
     # Secrets for committing the generated site
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}

.github/workflows/develocity-publish-build-scans.yaml

@@ -19,7 +19,6 @@
 .vscode
 /.metadata/
 /.mvn/wrapper/maven-wrapper.jar
-/.mvn/.develocity
 .flattened-pom.xml
 .project
 .settings

.gitignore

@@ -370,8 +370,6 @@
     <log4j.docgen.pluginDescriptorsDir.phase1>${maven.multiModuleProjectDirectory}/target/plugin-descriptors/phase1</log4j.docgen.pluginDescriptorsDir.phase1>
     <log4j.docgen.pluginDescriptorsDir.phase2>${maven.multiModuleProjectDirectory}/target/plugin-descriptors/phase2</log4j.docgen.pluginDescriptorsDir.phase2>
 
-    <!-- Downgrade temporarily Maven Surefire, since it breaks tests statistics on `develocity.apache.org` -->
-    <version.maven-surefire>3.2.5</version.maven-surefire>
   </properties>
 
   <dependencyManagement>

.mvn/develocity.xml

@@ -605,6 +605,20 @@ Dynamically choose a different appender for each log event
 
 See xref:manual/appenders/delegating.adoc[] for details.
 
+[#third-party]
+== Third-party appenders
+
+[WARNING]
+====
+These appenders are provided by **third-party** vendors and are not maintained by the link:{logging-services-url}[Apache Logging Services] project.
+====
+
+[#more-log4j2-AsyncHttpAppender]
+=== Async HTTP appender (`more-log4j2`)
+
+`AsyncHttpAppender` by https://github.com/mlangc/more-log4j2[more-log4j2] batches and optionally compresses log events, before sending them to backends.
+This way it is able to deliver high log volumes with little overhead.
+
 [#extending]
 == Extending
 

pom.xml

@@ -521,12 +521,12 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-loggin
 Log4j Core provides three rewrite policies out-of-the-box:
 
 [#MapRewritePolicy]
-`MapRewritePolicy`::
-+
+==== `MapRewritePolicy`
+
 The `MapRewritePolicy` only modifies events that contain a
 xref:manual/messages.adoc#MapMessage[`MapMessage`].
 It allows adding or updating the keys of the `MapMessage`.
-+
+
 [#MapRewritePolicy-attributes]
 .`MapRewritePolicy` configuration attributes
 [cols="1m,1,1,5"]
@@ -546,7 +546,7 @@ Update::
 The rewrite policy will add to the `MapMessage` only entries corresponding to existing keys.
 
 |===
-+
+
 [#MapRewritePolicy-elements]
 .`MapRewritePolicy` nested elements
 [cols="1m,1,4"]
@@ -561,20 +561,20 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-loggin
 A list of map entries to add to the `MapMessage`.
 
 |===
-+
+
 xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy[{plugin-reference-marker} Plugin reference for `MapRewritePolicy`]
 
 [#PropertiesRewritePolicy]
-`PropertiesRewritePolicy`::
-+
+==== `PropertiesRewritePolicy`
+
 The `PropertiesRewritePolicy` will add properties to the context data of the log event.
-+
+
 [NOTE]
 ====
 Only the context data of the log event will be modified.
 The contents of the xref:manual/thread-context.adoc[] will remain unchanged.
 ====
-+
+
 [#PropertiesRewritePolicy-elements]
 .`PropertiesRewritePolicy` nested elements
 [cols="1m,1,4"]
@@ -591,22 +591,22 @@ xref:manual/configuration.adoc#lazy-property-substitution[runtime property subst
 in the
 xref:manual/lookups.adoc#global-context[_global context_].
 |===
-+
+
 xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy[{plugin-reference-marker} Plugin reference for `PropertiesRewritePolicy`]
 
 [#LoggerNameLevelRewritePolicy]
-LoggerNameLevelRewritePolicy::
-+
+==== LoggerNameLevelRewritePolicy
+
 You can use this policy to change the log level of loggers from third-party libraries.
 The `LoggerNameLevelRewritePolicy` will rewrite the level of log event for a given logger name prefix.
-+
+
 [WARNING]
 ====
 The new log levels will only be used by the filter attached to the `Rewrite` appender and those downstream of the appender.
 Filters configured on loggers will use the previous levels.
 See xref:manual/filters.adoc[] for more details on filtering
 ====
-+
+
 [#LoggerNameLevelRewritePolicy-attributes]
 .`LoggerNameLevelRewritePolicy` configuration attributes
 [cols="1m,1,1,5"]
@@ -620,7 +620,7 @@ See xref:manual/filters.adoc[] for more details on filtering
 The rewrite policy will only be applied to loggers with this logger name and their children.
 
 |===
-+
+
 [#LoggerNameLevelRewritePolicy-elements]
 .`LoggerNameLevelRewritePolicy` nested elements
 [cols="1m,1,4"]
@@ -633,9 +633,23 @@ The rewrite policy will only be applied to loggers with this logger name and the
 Provides a mapping between old level names and new level names.
 
 |===
-+
+
 xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy[{plugin-reference-marker} Plugin reference for `LoggerNameLevelRewritePolicy`]
 
+[#ThirdPartyRewritePolicies]
+=== Third Party Rewrite Policies
+
+[WARNING]
+====
+These `Rewrite Policies` are provided by **third-party** vendors and are not maintained by the https://logging.apache.org/[Apache Logging Services] project.
+====
+
+[#MessageRewritePolicy]
+==== `MessageRewritePolicy`
+
+The `MessageRewritePolicy` provided by https://github.com/Neel1210/log4j-utils[log4j-utils] allows you to manipulate the text of a log message before it is processed by a downstream appender.
+This is particularly useful for defining multiple regex-based replacement rules to mask sensitive information (PII) within the log message as a defensive-in-depth strategy.
+
 [#RewriteAppender-examples]
 === Configuration example
 

src/site/antora/modules/ROOT/pages/manual/appenders.adoc

@@ -283,11 +283,23 @@ Additional headers can be configured using the nested
 If the appender receives a response with status code different from `2xx`, an exception is thrown.
 See also <<HttpAppender-attr-ignoreExceptions,`ignoreExceptions`>> configuration attribute.
 
+[WARNING]
+====
+Sending logs synchronously, one by one to an HTTP backend is rarely a good idea.
+In such a setup, every network or backend-related issue will immediately impact all loggers delegating to the HTTP Appender.
+Even when everything is working fine, log statements will block for tens or hundreds of milliseconds in a typical setup.
+This is orders of magnitude more than what you get with the xref:manual/appenders.adoc#ConsoleAppender[console appender] and the xref:manual/appenders/file.adoc[file appender].
+Also consider the number of HTTP requests and the associated network traffic that can result from such a setup.
+
+Consider at least xref:manual/async.adoc[asynchronous loggers] if you want to use this appender.
+Otherwise, please have a look at xref:manual/appenders.adoc#third-party[third-party appenders].
+====
+
 [NOTE]
 ====
 The implementation uses
 https://docs.oracle.com/javase/{java-target-version}/docs/api/java/net/HttpURLConnection.html[`HttpURLConnection`]
-under the hood.
+The implementation uses https://docs.oracle.com/javase/{java-target-version}/docs/api/java/net/HttpURLConnection.html[`HttpURLConnection`] under the hood.
 ====
 
 [#HttpAppender-attributes]