You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by pk...@apache.org on 2024/09/01 20:56:22 UTC
(logging-log4j2) 01/01: Document `DisruptorBlockingQueue` move
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch feature/main/move-conversant
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 655c4679311317cfa17896238e541dadb2e1f249
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Sun Sep 1 22:48:13 2024 +0200
Document `DisruptorBlockingQueue` move
---
src/changelog/.3.x.x/move_conversant_queue.xml | 7 ++++
src/site/antora/modules/ROOT/pages/components.adoc | 17 +++++++++
.../ROOT/pages/manual/appenders/delegating.adoc | 25 ++-----------
.../modules/ROOT/pages/manual/migration.adoc | 5 ++-
.../modules/ROOT/pages/plugin-reference.adoc | 2 +-
.../ROOT/partials/components/log4j-conversant.adoc | 41 ++++++++++++++++++++++
.../ROOT/partials/features/queue-conversant.adoc | 21 +++++++++++
7 files changed, 93 insertions(+), 25 deletions(-)
diff --git a/src/changelog/.3.x.x/move_conversant_queue.xml b/src/changelog/.3.x.x/move_conversant_queue.xml
new file mode 100644
index 0000000000..fe19b366f7
--- /dev/null
+++ b/src/changelog/.3.x.x/move_conversant_queue.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="https://logging.apache.org/xml/ns"
+ xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+ type="changed">
+ <description format="asciidoc">Move `DisruptorBlockingQueue` plugin to new `log4j-conversant` module.</description>
+</entry>
diff --git a/src/site/antora/modules/ROOT/pages/components.adoc b/src/site/antora/modules/ROOT/pages/components.adoc
index b354b6b91f..54bfcc0cda 100644
--- a/src/site/antora/modules/ROOT/pages/components.adoc
+++ b/src/site/antora/modules/ROOT/pages/components.adoc
@@ -103,6 +103,23 @@ See xref:manual/configuration.adoc#configuration-factories[predefined `Configura
include::partial$components/log4j-config-yaml.adoc[]
+[#log4j-conversant]
+== `log4j-conversant`
+
+|===
+| JPMS module
+| `org.apache.logging.log4j.conversant`
+|===
+
+The `log4j-conversant` artifact contains a
+xref:manual/appenders/delegating.adoc#BlockingQueueFactory[blocking queue factory]
+that uses
+https://github.com/conversant/disruptor[Conversant Disruptor BlockingQueue].
+
+See xref:manual/appenders/delegating.adoc#DisruptorBlockingQueueFactory[Disruptor Blocking Queue] for more details.
+
+include::partial$components/log4j-conversant.adoc[]
+
[#log4j-core]
== `log4j-core`
diff --git a/src/site/antora/modules/ROOT/pages/manual/appenders/delegating.adoc b/src/site/antora/modules/ROOT/pages/manual/appenders/delegating.adoc
index a717e5c6ce..d2375bc628 100644
--- a/src/site/antora/modules/ROOT/pages/manual/appenders/delegating.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/appenders/delegating.adoc
@@ -265,31 +265,10 @@ The `SpinPolicy` to apply, when adding elements to the queue.
.Additional dependencies are required to use `DisruptorBlockingQueue`
[%collapsible]
=====
-[tabs]
-====
-Maven::
-+
-[source,xml,subs="+attributes"]
-----
-<dependency>
- <groupId>com.conversantmedia</groupId>
- <artifactId>disruptor</artifactId>
- <version>{conversant-version}</version>
- <scope>runtime</scope>
-</dependency>
-----
-
-Gradle::
-+
-[source,groovy,subs="+attributes"]
-----
-runtimeOnly 'com.conversantmedia:disruptor:{conversant-version}'
-----
-
-====
+include::partial$features/queue-conversant.adoc[]
=====
+
-xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory[{plugin-reference-marker} Plugin reference for `DisruptorBlockingQueue`]
+xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-conversant_org-apache-logging-log4j-conversant-DisruptorBlockingQueueFactory[{plugin-reference-marker} Plugin reference for `DisruptorBlockingQueue`]
[#JCToolsBlockingQueueFactory]
`JCToolsBlockingQueue`::
diff --git a/src/site/antora/modules/ROOT/pages/manual/migration.adoc b/src/site/antora/modules/ROOT/pages/manual/migration.adoc
index 5534f6d374..60ccb690e0 100644
--- a/src/site/antora/modules/ROOT/pages/manual/migration.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/migration.adoc
@@ -53,7 +53,10 @@ The following `log4j-core` features were moved to their own modules or were remo
|===
| Log4j 2 feature | Log4j 3 module
-| xref:manual/appenders/delegating.adoc#BlockingQueueFactory[Asynchronous appender: JCTools-based queue]
+| xref:manual/appenders/delegating.adoc#DisruptorBlockingQueueFactory[Asynchronous appender: Disruptor-based queue]
+| xref:components.adoc#log4j-conversant[`log4j-conversant`]
+
+| xref:manual/appenders/delegating.adoc#JCToolsBlockingQueueFactory[Asynchronous appender: JCTools-based queue]
| xref:components.adoc#log4j-jctools[`log4j-jctools`]
| xref:manual/async.adoc[Asynchronous logger]
diff --git a/src/site/antora/modules/ROOT/pages/plugin-reference.adoc b/src/site/antora/modules/ROOT/pages/plugin-reference.adoc
index ebcc9b60ba..d049529bc3 100644
--- a/src/site/antora/modules/ROOT/pages/plugin-reference.adoc
+++ b/src/site/antora/modules/ROOT/pages/plugin-reference.adoc
@@ -269,7 +269,7 @@ The purpose of the sections below is to remove IDE errors while editing configur
== AsyncWaitStrategyFactory
[#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-BlockingQueueFactory]
== `BlockingQueueFactory`
-[#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory]
+[#org-apache-logging-log4j_log4j-conversant_org-apache-logging-log4j-conversant-DisruptorBlockingQueueFactory]
== DisruptorBlockingQueue
[#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory]
== JCToolsBlockingQueue
diff --git a/src/site/antora/modules/ROOT/partials/components/log4j-conversant.adoc b/src/site/antora/modules/ROOT/partials/components/log4j-conversant.adoc
new file mode 100644
index 0000000000..ba783ef06a
--- /dev/null
+++ b/src/site/antora/modules/ROOT/partials/components/log4j-conversant.adoc
@@ -0,0 +1,41 @@
+////
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+////
+
+[tabs]
+====
+Maven::
++
+We assume you use xref:components.adoc#log4j-bom[`log4j-bom`] for dependency management.
++
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-conversant</artifactId>
+ <scope>runtime</scope>
+</dependency>
+----
+
+Gradle::
++
+We assume you use xref:components.adoc#log4j-bom[`log4j-bom`] for dependency management.
++
+[source,groovy]
+----
+runtimeOnly 'org.apache.logging.log4j:log4j-conversant'
+----
+====
\ No newline at end of file
diff --git a/src/site/antora/modules/ROOT/partials/features/queue-conversant.adoc b/src/site/antora/modules/ROOT/partials/features/queue-conversant.adoc
new file mode 100644
index 0000000000..2d8b17c405
--- /dev/null
+++ b/src/site/antora/modules/ROOT/partials/features/queue-conversant.adoc
@@ -0,0 +1,21 @@
+////
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+////
+
+// This file exists in both the 2.x and 3.x branches.
+// It contains the dependencies required to enable the blocking queue based on JCTools.
+
+include::partial$components/log4j-conversant.adoc[]
\ No newline at end of file