Skip to content
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

fix: tcp_keepalive socket #3140

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix: tcp_keepalive socket #3140

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
33 changes: 31 additions & 2 deletions botocore/args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,8 +484,37 @@ def _compute_socket_options(self, scoped_config, client_config=None):
scoped_config.get("tcp_keepalive", False)
)
# Enables TCP Keepalive if specified in client config object or shared config file.
if client_keepalive or scoped_keepalive:
socket_options.append((socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1))
if not client_keepalive and not scoped_keepalive:
return socket_options

seconds_in_a_minute = 60

client_read_timeout = client_config and client_config.read_timeout
scoped_read_timeout = scoped_config.get("read_timeout", None)

read_timeout = (
scoped_read_timeout if scoped_read_timeout else client_read_timeout
) or seconds_in_a_minute

maximum_keepalive_probes = int(read_timeout / seconds_in_a_minute) or 1
keep_idle = (
seconds_in_a_minute
if read_timeout > seconds_in_a_minute
else read_timeout
)

socket_options.extend(
[
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, keep_idle),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, keep_idle),
(
socket.IPPROTO_TCP,
socket.TCP_KEEPCNT,
maximum_keepalive_probes,
),
],
)
return socket_options

def _compute_retry_config(self, config_kwargs):
Expand Down
57 changes: 53 additions & 4 deletions tests/unit/test_args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,12 @@ def test_tcp_keepalive_enabled_scoped_config(self):
self.assert_create_endpoint_call(
m,
socket_options=self.default_socket_options
+ [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+ [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 1),
],
)

def test_tcp_keepalive_not_specified(self):
Expand All @@ -247,7 +252,12 @@ def test_tcp_keepalive_enabled_if_set_anywhere(self):
self.assert_create_endpoint_call(
m,
socket_options=self.default_socket_options
+ [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+ [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 1),
],
)
self.call_get_client_args(
scoped_config={'tcp_keepalive': 'false'},
Expand All @@ -256,7 +266,41 @@ def test_tcp_keepalive_enabled_if_set_anywhere(self):
self.assert_create_endpoint_call(
m,
socket_options=self.default_socket_options
+ [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+ [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 1),
],
)
self.call_get_client_args(
scoped_config={'tcp_keepalive': 'false'},
client_config=Config(tcp_keepalive=True, read_timeout=30),
)
self.assert_create_endpoint_call(
m,
socket_options=self.default_socket_options
+ [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 30),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 30),
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 1),
],
timeout=(60, 30),
)
self.call_get_client_args(
scoped_config={'tcp_keepalive': 'false', 'read_timeout': 900},
client_config=Config(tcp_keepalive=True),
)
self.assert_create_endpoint_call(
m,
socket_options=self.default_socket_options
+ [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 15),
],
)

def test_tcp_keepalive_explicitly_disabled(self):
Expand All @@ -274,7 +318,12 @@ def test_tcp_keepalive_enabled_case_insensitive(self):
self.assert_create_endpoint_call(
m,
socket_options=self.default_socket_options
+ [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+ [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 1),
],
)

def test_client_config_has_use_dualstack_endpoint_flag(self):
Expand Down