From 874007f1ad764d18657c8f3f416d3c8cdcddc2a0 Mon Sep 17 00:00:00 2001 From: halo Date: Wed, 10 Jun 2026 09:12:16 +0900 Subject: [PATCH] GH-3142: Clarify republishToDlq default behaviour in docs The previous description opened with "By default, messages that fail after retries are exhausted are rejected", which implies the default is false (reject). The actual default is true (republish with extra headers). Rewrite the description to lead with the true default behaviour and describe the false case explicitly. Co-Authored-By: Claude Sonnet 4.6 --- .../rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc b/docs/modules/ROOT/pages/rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc index b57fd12e09..17e67fc6ef 100644 --- a/docs/modules/ROOT/pages/rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc +++ b/docs/modules/ROOT/pages/rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc @@ -272,9 +272,8 @@ When `republishToDlq` is `true`, specifies the delivery mode of the republished + Default: `DeliveryMode.PERSISTENT` republishToDlq:: -By default, messages that fail after retries are exhausted are rejected. -If a dead-letter queue (DLQ) is configured, RabbitMQ routes the failed message (unchanged) to the DLQ. -If set to `true`, the binder republishs failed messages to the DLQ with additional headers, including the exception message and stack trace from the cause of the final failure. +When set to `true` (the default), the binder republishes failed messages to the dead-letter queue (DLQ) with additional headers, including the exception message and stack trace from the cause of the final failure. +When set to `false`, messages that fail after retries are exhausted are rejected; if a dead-letter queue is configured, RabbitMQ then routes the rejected message (unchanged, without extra headers) to the DLQ. Also see the xref:rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc#spring-cloud-stream-rabbit-frame-max-headroom[frameMaxHeadroom property]. + Default: `true`