diff options
author | Dana Powers <dana.powers@gmail.com> | 2019-12-28 21:53:24 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-28 21:53:24 -0800 |
commit | cf28da8420b007d836b0db9d865d74fee89cdbcd (patch) | |
tree | 72ac601718da673f35aa2edb7dbc6849c6b92416 /kafka/client_async.py | |
parent | b59323d302ad7217d9a96cb05f4ecb47c72064f2 (diff) | |
download | kafka-python-cf28da8420b007d836b0db9d865d74fee89cdbcd.tar.gz |
Improve docs for reconnect_backoff_max_ms (#1976)
Diffstat (limited to 'kafka/client_async.py')
-rw-r--r-- | kafka/client_async.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/kafka/client_async.py b/kafka/client_async.py index 87b3fe0..4630b90 100644 --- a/kafka/client_async.py +++ b/kafka/client_async.py @@ -69,13 +69,14 @@ class KafkaClient(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. connections_max_idle_ms: Close idle connections after the number of |