The following binder, consumer, and producer properties are specific to binder implementations.
By default, the RabbitMQ binder uses Spring Boot’s ConnectionFactory, and it therefore supports all Spring Boot configuration options for RabbitMQ.
(For reference, consult the Spring Boot documentation.) RabbitMQ configuration options use the spring.rabbitmq prefix.
In addition to the Spring Boot options, the RabbitMQ binder supports the following properties:
A comma-separated list of RabbitMQ management plugin URLs.
Only used when nodes contains more than one entry.
Each entry in this list must have a corresponding entry in spring.rabbitmq.addresses.
Default: empty.
A comma-separated list of RabbitMQ node names.
When more than one entry, used to locate the server address where a queue is located.
Each entry in this list must have a corresponding entry in spring.rabbitmq.addresses.
Default: empty.
Compression level for compressed bindings.
See java.util.zip.Deflater.
Default: 1 (BEST_LEVEL).
The following properties are available for Rabbit consumers only and
must be prefixed with spring.cloud.stream.rabbit.bindings.<channelName>.consumer..
The acknowledge mode.
Default: AUTO.
Whether to automatically declare the DLQ and bind it to the binder DLX.
Default: false.
Whether subscription should be durable.
Only effective if group is also set.
Default: true.
1.Prefetch count.
Default: 1.
A prefix to be added to the name of the destination and queues.
Default: "".
Whether delivery failures should be requeued.
Default: true.
The request headers to be transported.
Default: [STANDARD_REQUEST_HEADERS,'*'].
The reply headers to be transported.
Default: [STANDARD_REQUEST_HEADERS,'*'].
true, the bus will republish failed messages to the DLQ with additional headers, including the exception message and stack trace from the cause of the final failure.Whether to use transacted channels.
Default: false.
The number of deliveries between acks.
Default: 1.
The following properties are available for Rabbit producers only and
must be prefixed with spring.cloud.stream.rabbit.bindings.<channelName>.producer..
Whether to automatically declare the DLQ and bind it to the binder DLX.
Default: false.
Whether to enable message batching by producers.
Default: false.
The number of messages to buffer when batching is enabled.
Default: 100.
10000.5000.Whether data should be compressed when sent.
Default: false.
Delivery mode.
Default: PERSISTENT.
A prefix to be added to the name of the destination exchange.
Default: "".
The request headers to be transported.
Default: [STANDARD_REQUEST_HEADERS,'*'].
The reply headers to be transported.
Default: [STANDARD_REQUEST_HEADERS,'*'].
A list of brokers to which the Kafka binder will connect.
Default: localhost.
brokers allows hosts specified with or without port information (e.g., host1,host2:port2).
This sets the default port when no port is configured in the broker list.
Default: 9092.
A list of ZooKeeper nodes to which the Kafka binder can connect.
Default: localhost.
zkNodes allows hosts specified with or without port information (e.g., host1,host2:port2).
This sets the default port when no port is configured in the node list.
Default: 2181.
The list of custom headers that will be transported by the binder.
Default: empty.
The frequency, in milliseconds, with which offsets are saved.
Ignored if 0.
Default: 10000.
The frequency, in number of updates, which which consumed offsets are persisted.
Ignored if 0.
Mutually exclusive with offsetUpdateTimeWindow.
Default: 0.
The number of required acks on the broker.
Default: 1.
Effective only if autoCreateTopics or autoAddPartitions is set.
The global minimum number of partitions that the binder will configure on topics on which it produces/consumes data.
It can be superseded by the partitionCount setting of the producer or by the value of instanceCount * concurrency settings of the producer (if either is larger).
Default: 1.
The replication factor of auto-created topics if autoCreateTopics is active.
Default: 1.
If set to true, the binder will create new topics automatically.
If set to false, the binder will rely on the topics being already configured.
In the latter case, if the topics do not exist, the binder will fail to start.
Of note, this setting is independent of the auto.topic.create.enable setting of the broker and it does not influence it: if the server is set to auto-create topics, they may be created as part of the metadata retrieval request, with default broker settings.
Default: true.
If set to true, the binder will create add new partitions if required.
If set to false, the binder will rely on the partition size of the topic being already configured.
If the partition count of the target topic is smaller than the expected value, the binder will fail to start.
Default: false.
The following properties are available for Kafka consumers only and
must be prefixed with spring.cloud.stream.kafka.bindings.<channelName>.consumer..
Whether to autocommit offsets when a message has been processed.
If set to false, an Acknowledgment header will be available in the message headers for late acknowledgment.
Default: true.
Whether to reset offsets on the consumer to the value provided by startOffset.
Default: false.
The starting offset for new groups, or when resetOffsets is true.
Allowed values: earliest, latest.
Default: null (equivalent to earliest).
When set to true, it will send enable DLQ behavior for the consumer.
Messages that result in errors will be forwarded to a topic named error.<destination>.<group>.
This provides an alternative option to the more common Kafka replay scenario for the case when the number of errors is relatively small and replaying the entire original topic may be too cumbersome.
Default: false.
The following properties are available for Kafka producers only and
must be prefixed with spring.cloud.stream.kafka.bindings.<channelName>.producer..
Upper limit, in bytes, of how much data the Kafka producer will attempt to batch before sending.
Default: 16384.
Whether the producer is synchronous.
Default: false.
How long the producer will wait before sending in order to allow more messages to accumulate in the same batch. (Normally the producer does not wait at all, and simply sends all the messages that accumulated while the previous send was in progress.) A non-zero value may increase throughput at the expense of latency.
Default: 0.