From 5cda36d670702e571f39233e5c0368384960b956 Mon Sep 17 00:00:00 2001 From: roldanbob Date: Thu, 22 Aug 2024 17:36:32 -0400 Subject: [PATCH] DBZ-8090 Updates description of kafka.consumer.offset.commit.enabled --- ...afka-signals-configuration-properties.adoc | 25 ++++++++++--------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc index 497d8da3b..bf41ae681 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc @@ -18,11 +18,11 @@ The signaling topic must have a single partition. |[[{context}-property-signal-kafka-groupId]]<<{context}-property-signal-kafka-groupId, `+signal.kafka.groupId+`>> |kafka-signal -|The name of the group ID that is used by Kafka consumers. +|The name of the group ID that is used by Kafka consumers. |[[{context}-property-signal-kafka-bootstrap-servers]]<<{context}-property-signal-kafka-bootstrap-servers, `+signal.kafka.bootstrap.servers+`>> |No default -|A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster. +|A list of the host and port pairs that the connector uses to establish its initial connection to the Kafka cluster. Each pair references the Kafka cluster that is used by the {prodname} Kafka Connect process. |[[{context}-property-signal-kafka-poll-timeout-ms]]<<{context}-property-signal-kafka-poll-timeout-ms, `+signal.kafka.poll.timeout.ms+`>> @@ -31,15 +31,16 @@ Each pair references the Kafka cluster that is used by the {prodname} Kafka Conn |[[{context}-kafka-consumer-offset-commit-enabled]]<<{context}-kafka-consumer-offset-commit-enabled, `+kafka.consumer.offset.commit.enabled+`>> |`false` -|Enable the offset commit for the signal topic in order to guarantee At-Least-Once delivery. If disabled, only signals received when the consumer is up&running are processed. Any signals received when the consumer is down are lost. +|Specifies whether the connector processes signal requests that the signaling topic receives while the connector is off-line. +Choose one of the following settings: + +`false`:: {prodname} processes only signals that are sent while the connector is running. +When the connector is unavailable, the Kafka consumer does not commit an offset after it reads signals received by the signaling topic. +As a result, after the connector restarts, it processes only signals that it receives after the restart. +Earlier signals are ignored, and are effectively lost. +`true`:: Enables {prodname} to process signals that are sent while the connector is offline, helping to ensure At-Least-Once delivery. +The Kakfa consumer for the signaling topic commits a topic offset whenever it reads a signal, so that it maintains a persistent history of signals that the signaling topic receives while offline. +When you restart the connector, it resumes processing from the last stored position, and not just from the offset of the most recent request since the restart. + |=== - -[id="debezium-{context}-connector-pass-through-signals-kafka-consumer-configuration-properties"] -=== {prodname} connector pass-through signals Kafka consumer client configuration properties - -The {prodname} connector provides for pass-through configuration of the signals Kafka consumer. -Pass-through signals properties begin with the prefix `signals.consumer.*`. -For example, the connector passes properties such as `signal.consumer.security.protocol=SSL` to the Kafka consumer. - -{prodname} strips the prefixes from the properties before it passes the properties to the Kafka signals consumer.