Skip to content

Add gRPC timeout to Secret Manager access_secret_version call #63813

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

Draft
evgeniy-b wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −2
Draft

Add gRPC timeout to Secret Manager access_secret_version call #63813

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
22 changes: 20 additions & 2 deletions ...iders/google/src/airflow/providers/google/cloud/_internal_client/secret_manager_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from functools import cached_property
from typing import TYPE_CHECKING

from google.api_core.exceptions import InvalidArgument, NotFound, PermissionDenied
from google.api_core.exceptions import DeadlineExceeded, InvalidArgument, NotFound, PermissionDenied
from google.cloud.secretmanager_v1 import SecretManagerServiceClient

from airflow.providers.google.common.consts import CLIENT_INFO
Expand All @@ -31,6 +31,11 @@

SECRET_ID_PATTERN = r"^[a-zA-Z0-9-_]*$"

# Default timeout in seconds for Secret Manager gRPC calls. Without a deadline, a gRPC call
# to access_secret_version can block the calling thread indefinitely if Secret Manager is slow
# or unreachable.
ACCESS_SECRET_VERSION_TIMEOUT = 30


class _SecretManagerClient(LoggingMixin):
"""
Expand Down Expand Up @@ -75,7 +80,9 @@ def get_secret(self, secret_id: str, project_id: str, secret_version: str = "lat
"""
name = self.client.secret_version_path(project_id, secret_id, secret_version)
try:
response = self.client.access_secret_version(request={"name": name})
response = self.client.access_secret_version(
request={"name": name}, timeout=ACCESS_SECRET_VERSION_TIMEOUT
)
value = response.payload.data.decode("UTF-8")
return value
except NotFound:
Expand All @@ -97,3 +104,14 @@ def get_secret(self, secret_id: str, project_id: str, secret_version: str = "lat
secret_id,
)
return None
except DeadlineExceeded:
self.log.warning(
"Google Cloud API Call Error (DeadlineExceeded): "
"Secret Manager request for Secret ID %s timed out after %ss.",
secret_id,
ACCESS_SECRET_VERSION_TIMEOUT,
)
raise TimeoutError(
f"Secret Manager request for Secret ID {secret_id} timed out "
f"after {ACCESS_SECRET_VERSION_TIMEOUT}s"
)
Loading