Skip to content

Commit f5ddc79

Browse files
ppkarwaszvy
andcommitted
Document module deprecation in 2.x
Since layout deprecation was already done in #2527, we document: * The deprecation of some appenders, pointing to third-party alternatives, when possible. * The deprecation of the Log4j Tag library. The Spring Boot Lookup and Java EE SMTP Appender will disappear in version 3.x, but will be replaced with the Spring Boot 3 Lookup (in Spring Boot) and Jakarta EE SMTP Appender. Co-authored-by: Volkan Yazıcı <[email protected]>
1 parent 6fb4f90 commit f5ddc79

File tree

4 files changed

+47
-0
lines changed

4 files changed

+47
-0
lines changed

src/site/antora/modules/ROOT/pages/jakarta.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,12 @@ include::example$manual/webapp/AsyncServlet.java[tag=manual]
267267
[#log4j-taglib]
268268
=== Logging in JavaServer Pages
269269
270+
[WARNING]
271+
====
272+
*The Log4j Tag library is planned to be removed in the next major release!*
273+
If you are using this library, please get in touch with the Log4j maintainers using link:{logging-services-url}/support.html[the official support channels].
274+
====
275+
270276
To help users add logging statements to JavaServer Pages, Log4j provides a JSP tag library modeled after the
271277
https://web.archive.org/web/20140215182415/http://jakarta.apache.org/taglibs/log/[Jakarta Commons Log Tag library].
272278
To use it, you need to add the following runtime dependency to your web application project:

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ The `uuid` column is additionally converted into a `java.util.UUID` before being
190190
[#CassandraAppender]
191191
== Cassandra Appender
192192
193+
include::partial$manual/appender-deprecation.adoc[]
194+
193195
The Cassandra Appender writes its output to an
194196
https://cassandra.apache.org/_/index.html[Apache Cassandra]
195197
database.
@@ -806,6 +808,8 @@ include::example$manual/appenders/database/jdbc.sql[lines=17..-1]
806808
[#JpaAppender]
807809
== JPA Appender
808810
811+
include::partial$manual/appender-deprecation.adoc[]
812+
809813
The JPA Appender writes log events to a relational database table using the
810814
https://jakarta.ee/specifications/persistence/2.2/[Jakarta Persistence API 2.2].
811815
To use the appender, you need to:
@@ -1242,6 +1246,12 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-mongodb4_org-apache-lo
12421246
[#CouchDbProvider]
12431247
=== Apache CouchDB provider
12441248
1249+
[WARNING]
1250+
====
1251+
*This provider is planned to be removed in the next major release!*
1252+
If you are using this library, please get in touch with the Log4j maintainers using link:{logging-services-url}/support.html[the official support channels].
1253+
====
1254+
12451255
The `CouchDb` Provider allows using the <<NoSqlAppender>> with an
12461256
https://couchdb.apache.org/[Apache CouchDB database].
12471257
The provider can be configured by:

src/site/antora/modules/ROOT/pages/manual/appenders/message-queue.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -679,6 +679,8 @@ include::example$manual/appenders/message-queue/jms-message.properties[tag=appen
679679
[[KafkaAppender]]
680680
== Kafka Appender
681681
682+
include::partial$manual/appender-deprecation.adoc[]
683+
682684
The KafkaAppender logs events to an https://kafka.apache.org/[Apache Kafka] topic.
683685
Each log event is sent as a
684686
https://kafka.apache.org/30/javadoc/org/apache/kafka/clients/producer/ProducerRecord.html[`ProducerRecord<byte[\], byte[\]>`], where:
@@ -903,6 +905,13 @@ include::example$manual/appenders/message-queue/kafka.properties[tag=loggers]
903905
[[JeroMqAppender]]
904906
== ZeroMQ/JeroMQ Appender
905907
908+
[WARNING]
909+
====
910+
*This appender is planned to be removed in the next major release!*
911+
Users should consider switching to
912+
https://github.com/fbacchella/loghublog4j2#zmqappender[a third-party `ZMQ` appender].
913+
====
914+
906915
The ZeroMQ appender uses the https://github.com/zeromq/jeromq[JeroMQ] library to send log events to one or more ZeroMQ endpoints.
907916
908917
[#JeroMqAppender-attributes]
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
////
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
////
17+
18+
[WARNING]
19+
====
20+
*This appender is planned to be removed in the next major release!*
21+
If you are using this library, please get in touch with the Log4j maintainers using link:{logging-services-url}/support.html[the official support channels].
22+
====

0 commit comments

Comments
 (0)