Skip to content

Comments

MINOR: Fix Streams DLQ config typo in upgrade guide#21551

Open
lelerabino wants to merge 1 commit intoapache:trunkfrom
lelerabino:lelerabinofix-streams-upgrade-dlq-doc
Open

MINOR: Fix Streams DLQ config typo in upgrade guide#21551
lelerabino wants to merge 1 commit intoapache:trunkfrom
lelerabino:lelerabinofix-streams-upgrade-dlq-doc

Conversation

@lelerabino
Copy link

@lelerabino lelerabino commented Feb 23, 2026

Problem

The Kafka Streams 4.2 upgrade guide documents the DLQ configuration as:

`errors.deadletterqueue.topic.name`

However the StreamsConfig constant defines the property as:

`errors.dead.letter.queue.topic.name`

This mismatch may lead users to configure the wrong property.

Solution

Update the upgrade guide to use the correct configuration key.

Scope

Documentation-only change. No functional impact.

### Problem

The Kafka Streams 4.2 upgrade guide documents the DLQ configuration as:

    `errors.deadletterqueue.topic.name`

However the StreamsConfig constant defines the property as:

    `errors.dead.letter.queue.topic.name`

This mismatch may lead users to configure the wrong property.

### Solution

Update the upgrade guide to use the correct configuration key.

### Scope

Documentation-only change. No functional impact.
@github-actions github-actions bot added triage PRs from the community docs small Small PRs labels Feb 23, 2026
### Other changes

Kafka Streams now supports Dead Letter Queue (DLQ). A new config `errors.deadletterqueue.topic.name` allows to specify the name of the DLQ topic. When set and `DefaultProductionExceptionHandler` is used, records that cause exceptions will be forwarded to the DLQ topic. If a custom exception handler is used, it is up to the custom handler to build DLQ records to send, hence, depending on the implementation, the `errors.deadletterqueue.topic.name` configuration may be ignored. `org.apache.kafka.streams.errors.ProductionExceptionHandler$ProductionExceptionHandlerResponse` is deprecated and replaced by `org.apache.kafka.streams.errors.ProductionExceptionHandler$Response`. Methods `handle` and `handleSerializationException` in `org.apache.kafka.streams.errors.ProductionExceptionHandler` are deprecated and replaced by `handleError` and `handleSerializationError` respectively in order to use the new `Response` class. More details can be found in [KIP-1034](https://cwiki.apache.org/confluence/x/HwviEQ).
Kafka Streams now supports Dead Letter Queue (DLQ). A new config `errors.dead.letter.queue.topic.name` allows to specify the name of the DLQ topic. When set and `DefaultProductionExceptionHandler` is used, records that cause exceptions will be forwarded to the DLQ topic. If a custom exception handler is used, it is up to the custom handler to build DLQ records to send, hence, depending on the implementation, the `errors.dead.letter.queue.topic.name` configuration may be ignored. `org.apache.kafka.streams.errors.ProductionExceptionHandler$ProductionExceptionHandlerResponse` is deprecated and replaced by `org.apache.kafka.streams.errors.ProductionExceptionHandler$Response`. Methods `handle` and `handleSerializationException` in `org.apache.kafka.streams.errors.ProductionExceptionHandler` are deprecated and replaced by `handleError` and `handleSerializationError` respectively in order to use the new `Response` class. More details can be found in [KIP-1034](https://cwiki.apache.org/confluence/x/HwviEQ).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice find. I have updated KIP as well

@mjsax mjsax removed the triage PRs from the community label Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants