summaryrefslogtreecommitdiff
path: root/kafka/conn.py
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2019-12-28 16:48:49 -0800
committerDana Powers <dana.powers@gmail.com>2019-12-28 16:48:49 -0800
commit159a7baad4fc5db0e35f413a4f94d1e0f75c830c (patch)
treecdf51bd2f20b11f35736d2b38746d76f71e28962 /kafka/conn.py
parent2ed01e96abd8e2b412aa5228131d531e91c50f76 (diff)
downloadkafka-python-reconnect_backoff_max_ms_doc_update.tar.gz
Improve docs for reconnect_backoff_max_msreconnect_backoff_max_ms_doc_update
Diffstat (limited to 'kafka/conn.py')
-rw-r--r--kafka/conn.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/kafka/conn.py b/kafka/conn.py
index bc01078..d4c5464 100644
--- a/kafka/conn.py
+++ b/kafka/conn.py
@@ -111,13 +111,14 @@ class BrokerConnection(object):
wait before attempting to reconnect to a given host.
Default: 50.
reconnect_backoff_max_ms (int): The maximum amount of time in
- milliseconds to wait when reconnecting to a broker that has
+ milliseconds to backoff/wait when reconnecting to a broker that has
repeatedly failed to connect. If provided, the backoff per host
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 backoff
- resulting in a random range between 20% below and 20% above
- the computed value. Default: 1000.
+ failure, up to this maximum. Once the maximum is reached,
+ reconnection attempts will continue periodically with this fixed
+ rate. To avoid connection storms, a randomization factor of 0.2
+ will be applied to the backoff resulting in a random range between
+ 20% below and 20% above the computed value. Default: 1000.
request_timeout_ms (int): Client request timeout in milliseconds.
Default: 30000.
max_in_flight_requests_per_connection (int): Requests are pipelined