You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2022/05/02 15:58:26 UTC
[GitHub] [kafka] C0urante commented on a diff in pull request #11874: Fix typos in configuration docs
C0urante commented on code in PR #11874:
URL: https://github.com/apache/kafka/pull/11874#discussion_r862970744
##########
clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java:
##########
@@ -216,8 +216,10 @@
private static final String MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION_DOC = "The maximum number of unacknowledged requests the client will send on a single connection before blocking."
+ " Note that if this config is set to be greater than 1 and <code>enable.idempotence</code> is set to false, there is a risk of"
+ " message re-ordering after a failed send due to retries (i.e., if retries are enabled)."
- + " Additionally, enabling idempotence requires this config value to be less than or equal to " + MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION_FOR_IDEMPOTENCE + "."
- + " If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled.";
+ + " Additionally, enabling idempotence requires the value of this configuration to be less than or equal to " + MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION_FOR_IDEMPOTENCE + "."
+ + " If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. "
+ + " Record ordering is preserved when <code>enable.idempotence</code> is set to true for idempotent "
+ + " producer (or transactional producer), even when max in-flight requests are greater than 1 (supported up to 5).";
Review Comment:
The last sentence is redundant though, isn't it? The docs already state:
> Note that if this config is set to be greater than 1 and <code>enable.idempotence</code> is set to false, there is a risk of message re-ordering after a failed send due to retries (i.e., if retries are enabled).
It's fine if we want to clarify that re-ordering is not a risk when `enable.idempotence` is set to true, but we should also try to keep the docs here concise.
What about adding a brief followup in that sentence instead?
> Note that if this config is set to be greater than 1 and <code>enable.idempotence</code> is set to false, there is a risk of message re-ordering after a failed send due to retries (i.e., if retries are enabled); ordering will be preserved if retries are disabled and/or <code>enable.idempotence</code> is true.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org