Skip to content

rest: apply sane default timeout on requests #2610

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

rest: apply sane default timeout on requests #2610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0609e32
rest: apply sane default timeout on requests
wdauchy Jun 5, 2025
b4366f4
pre-commit fixes
Jun 5, 2025
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
21 changes: 15 additions & 6 deletions .generator/src/generator/templates/rest.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ logger = logging.getLogger(__name__)

RETRY_AFTER_STATUS_CODES = frozenset([429, 500, 501, 502, 503, 504, 505, 506, 507, 509, 510, 511, 512])
RETRY_ALLOWED_METHODS = frozenset(["GET", "PUT", "DELETE", "POST", "PATCH"])
# apply sane default for calls to datadog API which has 60s timeout
DEFAULT_TIMEOUT = 55
DEFAULT_IDLE_CONN_MS = 55000


class ClientRetry(urllib3.util.Retry):
Expand Down Expand Up @@ -138,7 +141,7 @@ class RESTClientObject:
post_params = post_params or {}
headers = headers or {}

timeout = None
timeout = urllib3.Timeout(total=DEFAULT_TIMEOUT)
if request_timeout:
if isinstance(request_timeout, (int, float)):
timeout = urllib3.Timeout(total=request_timeout)
Expand Down Expand Up @@ -238,7 +241,13 @@ class AsyncRESTClientObject:
proxy = None
if configuration.proxy:
proxy = aiosonic.Proxy(configuration.proxy, configuration.proxy_headers)
self._client = aiosonic.HTTPClient(proxy=proxy, verify_ssl=configuration.verify_ssl)
pool_configs = {
":default": aiosonic.PoolConfig(
max_conn_idle_ms=DEFAULT_IDLE_CONN_MS
)
}
connector = aiosonic.TCPConnector(pool_configs=pool_configs)
self._client = aiosonic.HTTPClient(connector=connector, proxy=proxy, verify_ssl=configuration.verify_ssl)
self._configuration = configuration

def close(self):
Expand Down Expand Up @@ -286,13 +295,13 @@ class AsyncRESTClientObject:
(connection, read) timeouts.
"""
assert not post_params, "not supported for now"
from aiosonic.timeout import Timeouts # type: ignore
timeout = Timeouts(request_timeout=DEFAULT_TIMEOUT)
if request_timeout is not None:
from aiosonic.timeout import Timeouts # type: ignore

if isinstance(request_timeout, (int, float)):
request_timeout = Timeouts(request_timeout=request_timeout)
timeout = Timeouts(request_timeout=request_timeout)
else:
request_timeout = Timeouts(sock_connect=request_timeout[0], sock_read=request_timeout[1])
timeout = Timeouts(sock_connect=request_timeout[0], sock_read=request_timeout[1])
request_body = None
if (
"Content-Type" not in headers
Expand Down
18 changes: 12 additions & 6 deletions src/datadog_api_client/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@

RETRY_AFTER_STATUS_CODES = frozenset([429, 500, 501, 502, 503, 504, 505, 506, 507, 509, 510, 511, 512])
RETRY_ALLOWED_METHODS = frozenset(["GET", "PUT", "DELETE", "POST", "PATCH"])
# apply sane default for calls to datadog API which has 60s timeout
DEFAULT_TIMEOUT = 55
DEFAULT_IDLE_CONN_MS = 55000


class ClientRetry(urllib3.util.Retry):
Expand Down Expand Up @@ -140,7 +143,7 @@ def request(
post_params = post_params or {}
headers = headers or {}

timeout = None
timeout = urllib3.Timeout(total=DEFAULT_TIMEOUT)
if request_timeout:
if isinstance(request_timeout, (int, float)):
timeout = urllib3.Timeout(total=request_timeout)
Expand Down Expand Up @@ -240,7 +243,9 @@ def __init__(self, configuration):
proxy = None
if configuration.proxy:
proxy = aiosonic.Proxy(configuration.proxy, configuration.proxy_headers)
self._client = aiosonic.HTTPClient(proxy=proxy, verify_ssl=configuration.verify_ssl)
pool_configs = {":default": aiosonic.PoolConfig(max_conn_idle_ms=DEFAULT_IDLE_CONN_MS)}
connector = aiosonic.TCPConnector(pool_configs=pool_configs)
self._client = aiosonic.HTTPClient(connector=connector, proxy=proxy, verify_ssl=configuration.verify_ssl)
self._configuration = configuration

def close(self):
Expand Down Expand Up @@ -290,13 +295,14 @@ async def request(
(connection, read) timeouts.
"""
assert not post_params, "not supported for now"
if request_timeout is not None:
from aiosonic.timeout import Timeouts # type: ignore
from aiosonic.timeout import Timeouts # type: ignore

timeout = Timeouts(request_timeout=DEFAULT_TIMEOUT)
if request_timeout is not None:
if isinstance(request_timeout, (int, float)):
request_timeout = Timeouts(request_timeout=request_timeout)
timeout = Timeouts(request_timeout=request_timeout)
else:
request_timeout = Timeouts(sock_connect=request_timeout[0], sock_read=request_timeout[1])
timeout = Timeouts(sock_connect=request_timeout[0], sock_read=request_timeout[1])
request_body = None
if (
"Content-Type" not in headers
Expand Down
Loading