[GitHub] [ignite] timoninmaxim commented on a diff in pull request #10488: IGNITE-18574 CDC: add documentation about Kafka request timeouts

["timoninmaxim (via GitHub)" <gi...@apache.org>]

timoninmaxim commented on code in PR #10488:
URL: https://github.com/apache/ignite/pull/10488#discussion_r1161593746


##########
docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc:
##########
@@ -175,6 +183,16 @@ Kafka to Ignite configuration file should contain the following beans that will
 | `threadCount` | Count of threads to proceed consumers. Each thread poll records from dedicated partitions in round-robin manner. | 16
 |===
 
+`kafkaRequestTimeout` property sets timeouts for a following `KafkaConsumer` operations:
+
+- Poll from event and metadata topics.

Review Comment:
   Do we actually need list of these operations? Is there any kafka request that doesn't use this timeout?



##########
docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc:
##########
@@ -175,6 +183,16 @@ Kafka to Ignite configuration file should contain the following beans that will
 | `threadCount` | Count of threads to proceed consumers. Each thread poll records from dedicated partitions in round-robin manner. | 16
 |===
 
+`kafkaRequestTimeout` property sets timeouts for a following `KafkaConsumer` operations:
+
+- Poll from event and metadata topics.
+- Offsets commit.
+- Closing of a consumer.
+- Offsets request (during metadata updates).
+- Metadata topic partitions request (during metadata updater start).
+
+NOTE: _Too low value_ of `kafkaRequestTimeout` can lead to frequent failures of `kafka-to-ignite.sh` because of possible delays in network or on Kafka broker. Also, proper `KafkaConsumer` configuration should be provided, including link:https://kafka.apache.org/documentation/#consumerconfigs_request.timeout.ms[request.timeout.ms]. For more details you should refer to a link:https://kafka.apache.org/documentation/#configuration[configuration] section of the official Kafka documentation.

Review Comment:
   Same comment for font.



##########
docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc:
##########
@@ -113,6 +113,14 @@ image:../../assets/images/integrations/CDC-ignite2kafka.svg[]
 | `kafkaRequestTimeout` | Kafka request timeout in milliseconds.  | `3000`
 |===
 
+`kafkaRequestTimeout` property sets how much `IgniteToKafkaCdcStreamer` will wait for `KafkaProducer` to finish request.
+
+NOTE: _Too low value_ of this timeout can lead to frequent failures of `IgniteToKafkaCdcStreamer`

Review Comment:
   For me, using NOTE is enough for the emphasis. No need in using italic font here.



##########
docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc:
##########
@@ -113,6 +113,14 @@ image:../../assets/images/integrations/CDC-ignite2kafka.svg[]
 | `kafkaRequestTimeout` | Kafka request timeout in milliseconds.  | `3000`
 |===
 
+`kafkaRequestTimeout` property sets how much `IgniteToKafkaCdcStreamer` will wait for `KafkaProducer` to finish request.
+
+NOTE: _Too low value_ of this timeout can lead to frequent failures of `IgniteToKafkaCdcStreamer`
+because of possible delays in network or on Kafka broker.
+Also, proper `KafkaProducer` configuration should be provided, including link:https://kafka.apache.org/documentation/#producerconfigs_request.timeout.ms[request.timeout.ms].

Review Comment:
   What is a purpose of this new line? Should this sentence be part of the NOTE or not? If not, please add additional empty line between the NOTE paragraph and the sentence.  



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org