ijuma commented on a change in pull request #11788:
URL: https://github.com/apache/kafka/pull/11788#discussion_r818184023
##########
File path:
clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java
##########
@@ -216,21 +216,22 @@
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)."
- +
" Note additionally that enabling idempotence requires this config value to be
less than or equal to " + MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION_FOR_IDEMPOTENCE
+ "."
+ +
" 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.";
/** <code>retries</code> */
public static final String RETRIES_CONFIG =
CommonClientConfigs.RETRIES_CONFIG;
private static final String RETRIES_DOC = "Setting a value greater than
zero will cause the client to resend any record whose send fails with a
potentially transient error."
+ " Note that this retry is no different than if the client resent
the record upon receiving the error."
- + " Allowing retries and disabling <code>enable.idempotence</code>
but without setting <code>" + MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION + "</code>
to 1 will potentially change the"
- + " ordering of records because if two batches are sent to a
single partition, and the first fails and is retried but the second"
- + " succeeds, then the records in the second batch may appear
first. Note additionally that produce requests will be"
- + " failed before the number of retries has been exhausted if the
timeout configured by"
+ + " Produce requests will be failed before the number of retries
has been exhausted if the timeout configured by"
+ " <code>" + DELIVERY_TIMEOUT_MS_CONFIG + "</code> expires first
before successful acknowledgement. Users should generally"
+ " prefer to leave this config unset and instead use <code>" +
DELIVERY_TIMEOUT_MS_CONFIG + "</code> to control"
+ " retry behavior."
- + " <p>"
+ + "<p>"
+ + "Allowing retries and disabling <code>enable.idempotence</code>
but without setting <code>" + MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION + "</code>
to 1 will potentially change the"
Review comment:
It reads weird to say
> disabling <code>enable.idempotence</code>
I would write the sentence as:
> Allowing retries while setting <code>enable.idempotence</code> to
<code>false</code> and <code>" + MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION +
"</code> to 1 will potentially change the"
I would also move this paragraph below:
> Enabling idempotence requires this config value to be greater than 0...
--
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-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
