Skip to content

Wire socket_connection_setup_timeout_ms / max_ms configs from manager to user-facing clients (consumer/producer/admin) #3129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dpkp merged 1 commit into from
Jul 16, 2026
+39 −0
Merged

Wire socket_connection_setup_timeout_ms / max_ms configs from manager to user-facing clients (consumer/producer/admin) #3129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions kafka/admin/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ class KafkaAdminClient(
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: 30000.
socket_connection_setup_timeout_ms (int): The maximum amount of time
the client will wait for the socket connection to be established.
If the connection is not established before the timeout elapses,
the client will close the socket and retry. Default: 10000.
socket_connection_setup_timeout_max_ms (int): 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. Default: 30000.
request_timeout_ms (int): Client request timeout in milliseconds.
Default: 30000.
default_api_timeout_ms (int): Default timeout in milliseconds for
Expand Down Expand Up @@ -218,6 +229,8 @@ class KafkaAdminClient(
'sasl_kerberos_service_name': 'kafka',
'sasl_kerberos_domain_name': None,
'sasl_oauth_token_provider': None,
'socket_connection_setup_timeout_ms': 10000,
'socket_connection_setup_timeout_max_ms': 30000,
'proxy_url': None,
'socks5_proxy': None, # deprecated

Expand Down
13 changes: 13 additions & 0 deletions kafka/consumer/group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,17 @@ class KafkaConsumer:
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: 30000.
socket_connection_setup_timeout_ms (int): The maximum amount of time
the client will wait for the socket connection to be established.
If the connection is not established before the timeout elapses,
the client will close the socket and retry. Default: 10000.
socket_connection_setup_timeout_max_ms (int): 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. Default: 30000.
max_in_flight_requests_per_connection (int): Requests are pipelined
to kafka brokers up to this number of maximum requests per
broker connection. Default: 5.
Expand Down Expand Up @@ -375,6 +386,8 @@ class KafkaConsumer:
'sasl_kerberos_service_name': 'kafka',
'sasl_kerberos_domain_name': None,
'sasl_oauth_token_provider': None,
'socket_connection_setup_timeout_ms': 10000,
'socket_connection_setup_timeout_max_ms': 30000,
'proxy_url': None,
'socks5_proxy': None, # deprecated
'kafka_client': KafkaNetClient,
Expand Down
13 changes: 13 additions & 0 deletions kafka/producer/kafka.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,17 @@ class KafkaProducer:
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: 30000.
socket_connection_setup_timeout_ms (int): The maximum amount of time
the client will wait for the socket connection to be established.
If the connection is not established before the timeout elapses,
the client will close the socket and retry. Default: 10000.
socket_connection_setup_timeout_max_ms (int): 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. Default: 30000.
max_in_flight_requests_per_connection (int): Requests are pipelined
to kafka brokers up to this number of maximum requests per
broker connection. Note that if this setting is set to be greater
Expand Down Expand Up @@ -471,6 +482,8 @@ class KafkaProducer:
'sasl_kerberos_service_name': 'kafka',
'sasl_kerberos_domain_name': None,
'sasl_oauth_token_provider': None,
'socket_connection_setup_timeout_ms': 10000,
'socket_connection_setup_timeout_max_ms': 30000,
'proxy_url': None,
'socks5_proxy': None, # deprecated
'kafka_client': KafkaNetClient,
Expand Down