Skip to content

Commit 4334987

Browse files
authored
GH-2699: Document Retry Limitation
Resolves #2699 `@RetryableTopic` is not supported with batch listeners.
1 parent 6e96d5a commit 4334987

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

spring-kafka-docs/src/main/asciidoc/kafka.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1489,6 +1489,9 @@ This contains all the data from the `ConsumerRecord` except the key and value.
14891489
====== Batch Listeners
14901490

14911491
Starting with version 1.1, you can configure `@KafkaListener` methods to receive the entire batch of consumer records received from the consumer poll.
1492+
1493+
IMPORTANT: <<retry-topic>> are not supported with batch listeners.
1494+
14921495
To configure the listener container factory to create batch listeners, you can set the `batchListener` property.
14931496
The following example shows how to do so:
14941497

spring-kafka-docs/src/main/asciidoc/retrytopic.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Version 2.9 changed the mechanism to bootstrap infrastructure beans; see <<retry
66
Achieving non-blocking retry / dlt functionality with Kafka usually requires setting up extra topics and creating and configuring the corresponding listeners.
77
Since 2.7 Spring for Apache Kafka offers support for that via the `@RetryableTopic` annotation and `RetryTopicConfiguration` class to simplify that bootstrapping.
88

9+
IMPORTANT: Non-blocking retries are not supported with <<batch-listeners>>.
10+
911
==== How The Pattern Works
1012

1113
If message processing fails, the message is forwarded to a retry topic with a back off timestamp.

0 commit comments

Comments
 (0)