Skip to content

Commit 6817afa

Browse files
committed
Docs: clarify default non-blocking retry setup
Signed-off-by: 이유리 <[email protected]>
1 parent b23a88e commit 6817afa

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

spring-kafka-docs/src/main/antora/modules/ROOT/pages/retrytopic/retry-config.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
[[retry-config]]
22
= Configuration
33

4-
Starting with version 2.9, for default configuration, the `@EnableKafkaRetryTopic` annotation should be used in a `@Configuration` annotated class.
5-
This enables the feature to bootstrap properly and gives access to injecting some of the feature's components to be looked up at runtime.
4+
For the default setup, enable non-blocking retries by adding the `@RetryableTopic` annotation to a `@KafkaListener` method. This is the recommended and simplest approach, as it automatically configures the required retry infrastructure and creates the retry and DLT topics with default settings.
5+
6+
To import the non-blocking retry infrastructure and expose its components as beans, annotate a `@Configuration` class with `@EnableKafkaRetryTopic`. This enables injection and runtime lookup of the feature’s components and serves as a foundation for advanced and global configuration.
67

78
NOTE: It is not necessary to also add `@EnableKafka`, if you add this annotation, because `@EnableKafkaRetryTopic` is meta-annotated with `@EnableKafka`.
89

9-
Also, starting with that version, for more advanced configuration of the feature's components and global features, the `RetryTopicConfigurationSupport` class should be extended in a `@Configuration` class, and the appropriate methods overridden.
10-
For more details refer to xref:retrytopic/retry-config.adoc#retry-topic-global-settings[Configuring Global Settings and Features].
10+
For advanced and global customization, extend `RetryTopicConfigurationSupport` in a single `@Configuration` class and override the relevant methods.
1111

1212
By default, the containers for the retry topics will have the same concurrency as the main container.
1313
Starting with version 3.0, you can set a different `concurrency` for the retry containers (either on the annotation, or in `RetryTopicConfigurationBuilder`).
1414

15-
IMPORTANT: Only one of the above techniques can be used, and only one `@Configuration` class can extend `RetryTopicConfigurationSupport`.
15+
IMPORTANT: Use only one of the two global configuration approaches above (`@EnableKafkaRetryTopic` or extending `RetryTopicConfigurationSupport`). In addition, only one `@Configuration` class should extend `RetryTopicConfigurationSupport`.
1616

1717
[[using-the-retryabletopic-annotation]]
1818
== Using the `@RetryableTopic` annotation

0 commit comments

Comments
 (0)