KAFKA-12399: Deprecate KafkaLog4jAppender (apache#15985)

Reviewers: Chia-Ping Tsai <[email protected]>
gongxuanzhang · Jun 12, 2024 · d9da8ca · d9da8ca
1 parent 3a72cb4
commit d9da8ca
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/log4j-appender/src/main/java/org/apache/kafka/log4jappender/KafkaLog4jAppender.java b/log4j-appender/src/main/java/org/apache/kafka/log4jappender/KafkaLog4jAppender.java
@@ -55,8 +55,11 @@
 import static org.apache.kafka.common.config.SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG;
 
 /**
- * A log4j appender that produces log messages to Kafka
+ * A log4j appender that produces log messages to Kafka.
+ * This appender is deprecated and users should migrate to the log4j2 appender
+ * @see <a href="https://logging.apache.org/log4j/2.x/manual/appenders.html#KafkaAppender">KafkaAppender</a>
  */
+@Deprecated
 public class KafkaLog4jAppender extends AppenderSkeleton {
 
     private String brokerList;
@@ -337,6 +340,7 @@ public void activateOptions() {
         props.put(KEY_SERIALIZER_CLASS_CONFIG, ByteArraySerializer.class.getName());
         props.put(VALUE_SERIALIZER_CLASS_CONFIG, ByteArraySerializer.class.getName());
         this.producer = getKafkaProducer(props);
+        LogLog.warn("log4j-appender is deprecated and will be removed in Kafka 4.0.");
         LogLog.debug("Kafka producer connected to " + brokerList);
         LogLog.debug("Logging for topic: " + topic);
     }

diff --git a/log4j-appender/src/test/java/org/apache/kafka/log4jappender/MockKafkaLog4jAppender.java b/log4j-appender/src/test/java/org/apache/kafka/log4jappender/MockKafkaLog4jAppender.java
@@ -25,6 +25,7 @@
 import java.util.List;
 import java.util.Properties;
 
+@SuppressWarnings("deprecation")
 public class MockKafkaLog4jAppender extends KafkaLog4jAppender {
     private MockProducer<byte[], byte[]> mockProducer =
             new MockProducer<>(false, new MockSerializer(), new MockSerializer());