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

Jump to bottom

feat: Use float instead of int for GCE_METADATA_TIMEOUT #1481

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: Use float instead of int for GCE_METADATA_TIMEOUT #1481

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
03c0713
Update _metadata.py
ludoch Feb 20, 2024
7100b59
Update _metadata.py
ludoch Feb 23, 2024
1fe93bc
Merge branch 'googleapis:main' into main
ludoch Mar 21, 2024
51e12cd
Merge branch 'googleapis:main' into main
ludoch Apr 12, 2024
be068a5
Change timeout behavior and add a test for metadata server access. (#1)
ludoch Apr 12, 2024
f8007f2
add env var (#2)
ludoch Apr 12, 2024
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
10 changes: 5 additions & 5 deletions google/auth/compute_engine/_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,7 @@

# Timeout in seconds to wait for the GCE metadata server when detecting the
# GCE environment.
try:
_METADATA_DEFAULT_TIMEOUT = int(os.getenv("GCE_METADATA_TIMEOUT", 3))
except ValueError: # pragma: NO COVER
_METADATA_DEFAULT_TIMEOUT = 3
_METADATA_DEFAULT_TIMEOUT = 3
ludoch marked this conversation as resolved.
Show resolved Hide resolved

# Detect GCE Residency
_GOOGLE = "Google"
Expand Down Expand Up @@ -100,7 +97,7 @@ def detect_gce_residency_linux():
return content.startswith(_GOOGLE)


def ping(request, timeout=_METADATA_DEFAULT_TIMEOUT, retry_count=3):
def ping(request, timeout=None, retry_count=3):
"""Checks to see if the metadata server is available.

Args:
Expand All @@ -119,6 +116,9 @@ def ping(request, timeout=_METADATA_DEFAULT_TIMEOUT, retry_count=3):
# could lead to false negatives in the event that we are on GCE, but
# the metadata resolution was particularly slow. The latter case is
# "unlikely".
if timeout is None:
timeout = float(os.getenv("GCE_METADATA_TIMEOUT", _METADATA_DEFAULT_TIMEOUT))
ludoch marked this conversation as resolved.
Show resolved Hide resolved

retries = 0
headers = _METADATA_HEADERS.copy()
headers[metrics.API_CLIENT_HEADER] = metrics.mds_ping()
Expand Down