showuon commented on a change in pull request #11627:
URL: https://github.com/apache/kafka/pull/11627#discussion_r777395274



##########
File path: 
clients/src/main/java/org/apache/kafka/clients/CommonClientConfigs.java
##########
@@ -102,11 +119,16 @@
     public static final String DEFAULT_SECURITY_PROTOCOL = "PLAINTEXT";
 
     public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MS_CONFIG = 
"socket.connection.setup.timeout.ms";
-    public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MS_DOC = "The 
amount of time the client will wait for the socket connection to be 
established. If the connection is not built before the timeout elapses, clients 
will close the socket channel.";
+    public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MS_DOC = "The 
amount of time the client will wait for the socket connection to be 
established. " +
+        "If the connection is not built before the timeout elapses, clients 
will close the socket channel. " +
+        "This value is the initial backoff value and will increase 
exponentially for each consecutive connection failure, " +
+        "up to the <code>socket.connection.setup.timeout.max.ms</code> value.";
     public static final Long DEFAULT_SOCKET_CONNECTION_SETUP_TIMEOUT_MS = 10 * 
1000L;
 
     public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_CONFIG = 
"socket.connection.setup.timeout.max.ms";
-    public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_DOC = 
"The maximum amount of time the client will wait for the socket connection to 
be established. The connection setup timeout will increase exponentially for 
each consecutive connection failure up to this maximum. To avoid connection 
storms, a randomization factor of 0.2 will be applied to the timeout resulting 
in a random range between 20% below and 20% above the computed value.";
+    public static final String SOCKET_CONNECTION_SETUP_TIMEOUT_MAX_MS_DOC = 
"The maximum amount of time the client will wait for the socket connection to 
be established. " +
+        "The connection setup timeout will increase exponentially for each 
consecutive connection failure up to this maximum. To avoid connection storms, 
" +
+        "a randomization factor of 0.2 will be applied to the timeout 
resulting in a random range between 20% below and 20% above the computed 
value.";

Review comment:
       only make it into 3 lines, for better readability.




-- 
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


Reply via email to