google-api-core 2.36.0__tar.gz → 2.38.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_api_core-2.36.0/google_api_core.egg-info → google_api_core-2.38.0}/PKG-INFO +1 -1
- google_api_core-2.38.0/google/api_core/_observability.py +281 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/method.py +222 -6
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/version.py +1 -1
- {google_api_core-2.36.0 → google_api_core-2.38.0/google_api_core.egg-info}/PKG-INFO +1 -1
- google_api_core-2.38.0/tests/conftest.py +66 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/helpers.py +25 -0
- google_api_core-2.38.0/tests/unit/gapic/test_method.py +908 -0
- google_api_core-2.38.0/tests/unit/test_observability.py +544 -0
- google_api_core-2.36.0/google/api_core/_observability.py +0 -135
- google_api_core-2.36.0/tests/conftest.py +0 -31
- google_api_core-2.36.0/tests/unit/gapic/test_method.py +0 -348
- google_api_core-2.36.0/tests/unit/test_observability.py +0 -255
- {google_api_core-2.36.0 → google_api_core-2.38.0}/LICENSE +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/MANIFEST.in +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/README.rst +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/_feature_gating_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/_python_package_support.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/_python_version_support.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/_rest_streaming_base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/bidi.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/bidi_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/bidi_base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/client_info.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/client_logging.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/client_options.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/datetime_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/exceptions.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/extended_operation.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/future/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/future/_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/future/async_future.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/future/base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/future/polling.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/client_info.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/config.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/config_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/method_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/requests.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/gapic_v1/routing_header.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/general_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/grpc_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/grpc_helpers_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/iam.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operation.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operation_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/abstract_operations_base_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/abstract_operations_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/operations_async_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/operations_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/operations_client_config.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/operations_rest_client_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/pagers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/pagers_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/pagers_base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/transports/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/transports/base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/transports/rest.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/operations_v1/transports/rest_asyncio.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/page_iterator.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/page_iterator_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/path_template.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/protobuf_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/py.typed +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/rest_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/rest_streaming.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/rest_streaming_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry/retry_base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry/retry_streaming.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry/retry_streaming_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry/retry_unary.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry/retry_unary_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/retry_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/timeout.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/universe.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google/api_core/version_header.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google_api_core.egg-info/SOURCES.txt +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google_api_core.egg-info/dependency_links.txt +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google_api_core.egg-info/requires.txt +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/google_api_core.egg-info/top_level.txt +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/pyproject.toml +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/setup.cfg +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/setup.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/future/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/future/test_async_future.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/gapic/test_config_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/gapic/test_method_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/operations_v1/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/operations_v1/test_operations_async_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/retry/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/retry/test_retry_streaming_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/retry/test_retry_unary_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/test_bidi_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/test_grpc_helpers_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/test_operation_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/test_page_iterator_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/asyncio/test_rest_streaming_async.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/future/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/future/test__helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/future/test_polling.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/gapic/test_client_info.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/gapic/test_config.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/gapic/test_requests.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/gapic/test_routing_header.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/operations_v1/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/operations_v1/test_operations_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/operations_v1/test_operations_rest_client.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/retry/__init__.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/retry/test_retry_base.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/retry/test_retry_imports.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/retry/test_retry_streaming.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/retry/test_retry_unary.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_bidi.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_client_info.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_client_logging.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_client_options.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_datetime_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_exceptions.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_extended_operation.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_feature_gating_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_grpc_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_iam.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_operation.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_packaging.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_page_iterator.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_path_template.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_protobuf_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_python_package_support.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_python_version_support.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_rest_helpers.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_rest_streaming.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_timeout.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_universe.py +0 -0
- {google_api_core-2.36.0 → google_api_core-2.38.0}/tests/unit/test_version_header.py +0 -0
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
# Copyright 2026 Google LLC
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
|
|
17
|
+
"""OpenTelemetry helpers for resolving and instantiating interceptors."""
|
|
18
|
+
|
|
19
|
+
from __future__ import annotations
|
|
20
|
+
|
|
21
|
+
import urllib.parse
|
|
22
|
+
from typing import TYPE_CHECKING, Any, Callable, Sequence
|
|
23
|
+
|
|
24
|
+
from google.api_core import _feature_gating_helpers
|
|
25
|
+
from google.api_core.client_options import ClientOptions
|
|
26
|
+
|
|
27
|
+
if TYPE_CHECKING:
|
|
28
|
+
# flake8: grpc, trace, and ClientInterceptor are imported only for static analysis and type annotations
|
|
29
|
+
# The 'noqa: F401' comment avoids flake8 "imported but not used" errors.
|
|
30
|
+
import grpc # noqa: F401
|
|
31
|
+
import opentelemetry.trace # noqa: F401
|
|
32
|
+
|
|
33
|
+
from google.api_core.grpc_helpers import ClientInterceptor # noqa: F401
|
|
34
|
+
|
|
35
|
+
_TRACER_PROVIDER = "tracer_provider"
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def is_otel_capabilities_enabled(
|
|
39
|
+
client_options: ClientOptions | dict[str, Any] | None = None,
|
|
40
|
+
env_var: str = "GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED",
|
|
41
|
+
) -> bool:
|
|
42
|
+
"""Checks if OTel capabilities are enabled and installed.
|
|
43
|
+
|
|
44
|
+
Args:
|
|
45
|
+
client_options: The client options object or dictionary.
|
|
46
|
+
env_var: The environment variable to check for enablement.
|
|
47
|
+
|
|
48
|
+
Returns:
|
|
49
|
+
bool: True if enabled and installed, False otherwise.
|
|
50
|
+
"""
|
|
51
|
+
is_tracing_enabled = _feature_gating_helpers.resolve_feature_flags(
|
|
52
|
+
env_var=env_var,
|
|
53
|
+
feature_key=_TRACER_PROVIDER,
|
|
54
|
+
configuration=client_options,
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
if is_tracing_enabled:
|
|
58
|
+
try:
|
|
59
|
+
import opentelemetry.instrumentation.grpc as otel_grpc # type: ignore[import-not-found] # noqa: F401
|
|
60
|
+
|
|
61
|
+
return True
|
|
62
|
+
except ImportError:
|
|
63
|
+
pass
|
|
64
|
+
|
|
65
|
+
return False
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
def _extract_endpoint_attributes(
|
|
69
|
+
client_options: ClientOptions | dict[str, Any] | None = None,
|
|
70
|
+
) -> dict[str, Any]:
|
|
71
|
+
"""Extracts server.address, server.port (if non-default), and url.domain from client options if present.
|
|
72
|
+
|
|
73
|
+
Args:
|
|
74
|
+
client_options: The client options object or dictionary.
|
|
75
|
+
|
|
76
|
+
Returns:
|
|
77
|
+
dict[str, Any]: A dictionary containing url.domain and, if an api_endpoint is configured,
|
|
78
|
+
server.address and non-default server.port.
|
|
79
|
+
"""
|
|
80
|
+
attrs: dict[str, Any] = {}
|
|
81
|
+
endpoint = None
|
|
82
|
+
universe_domain = None
|
|
83
|
+
|
|
84
|
+
if isinstance(client_options, dict):
|
|
85
|
+
endpoint = client_options.get("api_endpoint")
|
|
86
|
+
universe_domain = client_options.get("universe_domain")
|
|
87
|
+
elif client_options is not None:
|
|
88
|
+
endpoint = getattr(client_options, "api_endpoint", None)
|
|
89
|
+
universe_domain = getattr(client_options, "universe_domain", None)
|
|
90
|
+
|
|
91
|
+
attrs["url.domain"] = universe_domain or "googleapis.com"
|
|
92
|
+
|
|
93
|
+
if endpoint and isinstance(endpoint, str):
|
|
94
|
+
target = endpoint if "//" in endpoint else f"//{endpoint}"
|
|
95
|
+
parsed = None
|
|
96
|
+
hostname = None
|
|
97
|
+
port = None
|
|
98
|
+
try:
|
|
99
|
+
parsed = urllib.parse.urlsplit(target)
|
|
100
|
+
hostname = parsed.hostname
|
|
101
|
+
port = parsed.port
|
|
102
|
+
except ValueError:
|
|
103
|
+
pass
|
|
104
|
+
|
|
105
|
+
if hostname:
|
|
106
|
+
attrs["server.address"] = hostname
|
|
107
|
+
if port and parsed:
|
|
108
|
+
scheme = parsed.scheme.lower()
|
|
109
|
+
is_default_port = (port == 443 and scheme in ("https", "")) or (
|
|
110
|
+
port == 80 and scheme == "http"
|
|
111
|
+
)
|
|
112
|
+
if not is_default_port:
|
|
113
|
+
attrs["server.port"] = port
|
|
114
|
+
return attrs
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
def _make_grpc_client_request_hook(
|
|
118
|
+
endpoint_attrs: dict[str, Any] | None = None,
|
|
119
|
+
) -> Callable[[Any, Any], None]:
|
|
120
|
+
"""Creates an OpenTelemetry gRPC client request hook with optional endpoint attributes.
|
|
121
|
+
|
|
122
|
+
Args:
|
|
123
|
+
endpoint_attrs: Optional static endpoint attributes to attach to every span.
|
|
124
|
+
|
|
125
|
+
Returns:
|
|
126
|
+
Callable[[Any, Any], None]: The request hook callback.
|
|
127
|
+
"""
|
|
128
|
+
static_attrs = dict(endpoint_attrs) if endpoint_attrs else {}
|
|
129
|
+
|
|
130
|
+
def client_request_hook(span: Any, request: Any) -> None:
|
|
131
|
+
if span is None or not getattr(span, "is_recording", lambda: True)():
|
|
132
|
+
return
|
|
133
|
+
|
|
134
|
+
# Upstream opentelemetry-instrumentation-grpc may format span names with a
|
|
135
|
+
# leading slash (e.g. "/package.Service/Method"). Normalize the span name
|
|
136
|
+
# and ensure rpc.method is always captured as the clean, fully-qualified name.
|
|
137
|
+
span_name = getattr(span, "name", None)
|
|
138
|
+
if isinstance(span_name, str) and span_name:
|
|
139
|
+
clean_method_name = span_name.lstrip("/")
|
|
140
|
+
if span_name.startswith("/") and hasattr(span, "update_name"):
|
|
141
|
+
span.update_name(clean_method_name)
|
|
142
|
+
span.set_attribute("rpc.method", clean_method_name)
|
|
143
|
+
|
|
144
|
+
attrs: dict[str, Any] = {
|
|
145
|
+
"rpc.system.name": "grpc",
|
|
146
|
+
}
|
|
147
|
+
if static_attrs:
|
|
148
|
+
attrs.update(static_attrs)
|
|
149
|
+
for key, value in attrs.items():
|
|
150
|
+
span.set_attribute(key, value)
|
|
151
|
+
|
|
152
|
+
return client_request_hook
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
_grpc_client_request_hook = _make_grpc_client_request_hook()
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
def _grpc_client_response_hook(span: Any, response: Any) -> None:
|
|
159
|
+
"""OpenTelemetry gRPC client response hook to record successful response status.
|
|
160
|
+
|
|
161
|
+
Upstream ``opentelemetry-instrumentation-grpc`` sets the integer status code
|
|
162
|
+
``rpc.grpc.status_code`` (e.g. 0), but does not record the modern string status
|
|
163
|
+
``rpc.response.status_code`` (e.g. "OK") required by Cloud Trace and current
|
|
164
|
+
OpenTelemetry semantic conventions (v1.27.0+).
|
|
165
|
+
|
|
166
|
+
This hook enriches successful RPC attempt spans with ``rpc.response.status_code = "OK"``.
|
|
167
|
+
Errors and non-OK statuses are handled at the Tier 3 method span layer or upstream.
|
|
168
|
+
|
|
169
|
+
Upstream handles synchronous and asynchronous invocations differently:
|
|
170
|
+
- **Synchronous gRPC**: Upstream only invokes the response hook when an RPC call
|
|
171
|
+
succeeds. On failure, the hook is bypassed entirely.
|
|
172
|
+
- **Asynchronous gRPC**: Upstream invokes the response hook unconditionally for
|
|
173
|
+
both successes and failures (passing exception details on error). However, it
|
|
174
|
+
always marks ``span.status`` with an error status before calling the hook.
|
|
175
|
+
|
|
176
|
+
Because of this disparity, this hook checks ``span.status`` to guard against
|
|
177
|
+
async failure callbacks while allowing synchronous and successful asynchronous
|
|
178
|
+
calls to be marked "OK".
|
|
179
|
+
|
|
180
|
+
Note:
|
|
181
|
+
If upstream ``opentelemetry-instrumentation-grpc`` adds native support for
|
|
182
|
+
modern ``rpc.response.status_code`` in future releases, this hook can be retired.
|
|
183
|
+
|
|
184
|
+
Args:
|
|
185
|
+
span: The OpenTelemetry span.
|
|
186
|
+
response: The gRPC response object or details.
|
|
187
|
+
"""
|
|
188
|
+
if not span.is_recording():
|
|
189
|
+
return
|
|
190
|
+
|
|
191
|
+
# Guard against upstream async calls that invoke this hook on failures.
|
|
192
|
+
status = getattr(span, "status", None)
|
|
193
|
+
status_code = getattr(status, "status_code", None)
|
|
194
|
+
if (
|
|
195
|
+
getattr(status_code, "name", None) == "ERROR"
|
|
196
|
+
or getattr(status_code, "value", None) == 2
|
|
197
|
+
):
|
|
198
|
+
return
|
|
199
|
+
|
|
200
|
+
span.set_attribute("rpc.response.status_code", "OK")
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
def _get_tracer_provider(
|
|
204
|
+
client_options: ClientOptions | dict[str, Any] | None = None,
|
|
205
|
+
) -> opentelemetry.trace.TracerProvider | None:
|
|
206
|
+
"""Extracts the OpenTelemetry tracer provider from client options if present.
|
|
207
|
+
|
|
208
|
+
Args:
|
|
209
|
+
client_options: The client options object or dictionary.
|
|
210
|
+
|
|
211
|
+
Returns:
|
|
212
|
+
opentelemetry.trace.TracerProvider | None: The tracer provider if present,
|
|
213
|
+
None otherwise.
|
|
214
|
+
"""
|
|
215
|
+
if isinstance(client_options, dict):
|
|
216
|
+
return client_options.get(_TRACER_PROVIDER)
|
|
217
|
+
elif client_options is not None:
|
|
218
|
+
return getattr(client_options, _TRACER_PROVIDER, None)
|
|
219
|
+
return None
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
def get_otel_interceptor(
|
|
223
|
+
client_options: ClientOptions | dict[str, Any] | None = None,
|
|
224
|
+
) -> Callable[[grpc.Channel], grpc.Channel] | None:
|
|
225
|
+
"""Returns an interceptor callable that wraps a sync gRPC channel with OpenTelemetry tracing.
|
|
226
|
+
|
|
227
|
+
Args:
|
|
228
|
+
client_options: The client options object or dictionary used for feature gating
|
|
229
|
+
and extracting the tracer provider.
|
|
230
|
+
|
|
231
|
+
Returns:
|
|
232
|
+
Callable[[grpc.Channel], grpc.Channel] | None: An interceptor callable if OpenTelemetry
|
|
233
|
+
tracing is enabled and installed, None otherwise.
|
|
234
|
+
"""
|
|
235
|
+
if not is_otel_capabilities_enabled(client_options):
|
|
236
|
+
return None
|
|
237
|
+
|
|
238
|
+
import opentelemetry.instrumentation.grpc as otel_grpc # type: ignore[import-not-found]
|
|
239
|
+
|
|
240
|
+
endpoint_attrs = _extract_endpoint_attributes(client_options)
|
|
241
|
+
request_hook = _make_grpc_client_request_hook(endpoint_attrs)
|
|
242
|
+
|
|
243
|
+
interceptor: ClientInterceptor = otel_grpc.client_interceptor(
|
|
244
|
+
tracer_provider=_get_tracer_provider(client_options),
|
|
245
|
+
request_hook=request_hook,
|
|
246
|
+
response_hook=_grpc_client_response_hook,
|
|
247
|
+
)
|
|
248
|
+
|
|
249
|
+
def otel_interceptor(channel: grpc.Channel) -> grpc.Channel:
|
|
250
|
+
return otel_grpc.intercept_channel(channel, interceptor)
|
|
251
|
+
|
|
252
|
+
return otel_interceptor
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
def get_otel_async_interceptor(
|
|
256
|
+
client_options: ClientOptions | dict[str, Any] | None = None,
|
|
257
|
+
) -> Sequence[grpc.aio.ClientInterceptor] | None:
|
|
258
|
+
"""Returns async gRPC client interceptors for OpenTelemetry tracing.
|
|
259
|
+
|
|
260
|
+
Args:
|
|
261
|
+
client_options: The client options object or dictionary used for feature gating
|
|
262
|
+
and extracting the tracer provider.
|
|
263
|
+
|
|
264
|
+
Returns:
|
|
265
|
+
Sequence[grpc.aio.ClientInterceptor] | None: Instantiated OpenTelemetry async
|
|
266
|
+
client interceptors if tracing is enabled and installed, None otherwise.
|
|
267
|
+
"""
|
|
268
|
+
if not is_otel_capabilities_enabled(client_options):
|
|
269
|
+
return None
|
|
270
|
+
|
|
271
|
+
# Ignored by mypy: Optional dependency only loaded if early-return is skipped
|
|
272
|
+
import opentelemetry.instrumentation.grpc as otel_grpc # type: ignore[import-not-found]
|
|
273
|
+
|
|
274
|
+
endpoint_attrs = _extract_endpoint_attributes(client_options)
|
|
275
|
+
request_hook = _make_grpc_client_request_hook(endpoint_attrs)
|
|
276
|
+
|
|
277
|
+
return otel_grpc.aio_client_interceptors(
|
|
278
|
+
tracer_provider=_get_tracer_provider(client_options),
|
|
279
|
+
request_hook=request_hook,
|
|
280
|
+
response_hook=_grpc_client_response_hook,
|
|
281
|
+
)
|
|
@@ -18,12 +18,14 @@ This is used by gapic clients to provide common error mapping, retry, timeout,
|
|
|
18
18
|
compression, pagination, and long-running operations to gRPC methods.
|
|
19
19
|
"""
|
|
20
20
|
|
|
21
|
+
import contextlib
|
|
21
22
|
import enum
|
|
22
23
|
import functools
|
|
23
|
-
from typing import List, Tuple
|
|
24
|
+
from typing import Any, List, Optional, Tuple
|
|
24
25
|
|
|
25
|
-
from google.api_core import grpc_helpers
|
|
26
|
+
from google.api_core import _observability, grpc_helpers
|
|
26
27
|
from google.api_core.gapic_v1 import client_info
|
|
28
|
+
from google.api_core.gapic_v1.client_info import METRICS_METADATA_KEY
|
|
27
29
|
from google.api_core.timeout import TimeToDeadlineTimeout
|
|
28
30
|
|
|
29
31
|
USE_DEFAULT_METADATA = object()
|
|
@@ -92,7 +94,7 @@ def _extract_metrics_header(metadata) -> Tuple[str, List[Tuple[str, str]]]:
|
|
|
92
94
|
if not metadata:
|
|
93
95
|
return "", []
|
|
94
96
|
|
|
95
|
-
key_to_find =
|
|
97
|
+
key_to_find = METRICS_METADATA_KEY
|
|
96
98
|
|
|
97
99
|
metric_str = _deduplicate_metadata_tokens(
|
|
98
100
|
" ".join([v for k, v in metadata if k == key_to_find])
|
|
@@ -104,6 +106,124 @@ def _extract_metrics_header(metadata) -> Tuple[str, List[Tuple[str, str]]]:
|
|
|
104
106
|
return metric_str, arbitrary_metadata
|
|
105
107
|
|
|
106
108
|
|
|
109
|
+
def _extract_rpc_identity(
|
|
110
|
+
method_name: str,
|
|
111
|
+
) -> Tuple[str, str, str]:
|
|
112
|
+
"""Extract (full_rpc_name, service_name, rpc_method_name) from an explicit method name.
|
|
113
|
+
|
|
114
|
+
Args:
|
|
115
|
+
method_name: Explicit RPC name (e.g. "/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion").
|
|
116
|
+
|
|
117
|
+
Returns:
|
|
118
|
+
Tuple[str, str, str]: A 3-tuple of (full_rpc_name, service_name, rpc_method_name).
|
|
119
|
+
"""
|
|
120
|
+
method_str = method_name.lstrip("/")
|
|
121
|
+
service, _, method = method_str.rpartition("/")
|
|
122
|
+
return method_str, service, method
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
def _extract_status_code(exc: Optional[Exception]) -> str:
|
|
126
|
+
"""Extract canonical status code name string from an exception.
|
|
127
|
+
|
|
128
|
+
Status code name strings are resolved by inspecting the following locations:
|
|
129
|
+
* Chained exceptions: Unwraps RetryError or __cause__ to the root exception.
|
|
130
|
+
* Enum & code attributes: Inspects .grpc_status_code on GoogleAPICallError or .code on gRPC errors.
|
|
131
|
+
* Integer status codes: Maps raw gRPC integer status codes to canonical enum names.
|
|
132
|
+
* Fallback: Defaults to the exception class name for standard Python errors.
|
|
133
|
+
|
|
134
|
+
Args:
|
|
135
|
+
exc (Optional[Exception]): The exception to extract the status code name from.
|
|
136
|
+
|
|
137
|
+
Returns:
|
|
138
|
+
str: The canonical status code name (e.g. "NOT_FOUND", "UNAVAILABLE") or class name.
|
|
139
|
+
"""
|
|
140
|
+
if exc is None:
|
|
141
|
+
return ""
|
|
142
|
+
|
|
143
|
+
# 1. Unwrap chained exceptions: unwrap RetryError or __cause__ to the root failure
|
|
144
|
+
target = getattr(exc, "cause", None) or getattr(exc, "__cause__", None) or exc
|
|
145
|
+
|
|
146
|
+
# 2. Check enum & code attributes: .grpc_status_code enum or callable/non-callable .code
|
|
147
|
+
status = getattr(target, "grpc_status_code", None)
|
|
148
|
+
if status is None and hasattr(target, "code"):
|
|
149
|
+
try:
|
|
150
|
+
status = target.code() if callable(target.code) else target.code
|
|
151
|
+
except Exception:
|
|
152
|
+
status = None
|
|
153
|
+
|
|
154
|
+
name = getattr(status, "name", None)
|
|
155
|
+
if name:
|
|
156
|
+
return str(name)
|
|
157
|
+
|
|
158
|
+
# 3. Check integer status codes: map raw gRPC integer status codes to canonical enum names
|
|
159
|
+
if isinstance(status, int):
|
|
160
|
+
from google.api_core import exceptions
|
|
161
|
+
|
|
162
|
+
status = exceptions._INT_TO_GRPC_CODE.get(status, status)
|
|
163
|
+
return getattr(status, "name", str(status))
|
|
164
|
+
|
|
165
|
+
# 4. Fallback: default to the exception class name for standard Python errors
|
|
166
|
+
return target.__class__.__name__
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
def _extract_error_attributes(exc: Optional[Exception]) -> dict[str, Any]:
|
|
170
|
+
"""Extract gcp.errors.* and error.type attributes from an exception.
|
|
171
|
+
|
|
172
|
+
Error details and ErrorInfo structures are resolved by inspecting the following locations:
|
|
173
|
+
* Chained exceptions: Unwraps RetryError or __cause__ to the root exception.
|
|
174
|
+
* GoogleAPICallError attributes: Reads ErrorInfo from ._error_info or .error_info.
|
|
175
|
+
* Native gRPC trailing metadata: Parses google.rpc.Status binary details from trailing_metadata.
|
|
176
|
+
* Unified attribute extraction: Extracts domain, reason, and metadata from ErrorInfo or exception attributes.
|
|
177
|
+
|
|
178
|
+
Args:
|
|
179
|
+
exc (Optional[Exception]): An exception (such as GoogleAPICallError or grpc.RpcError) or ErrorInfo object.
|
|
180
|
+
|
|
181
|
+
Returns:
|
|
182
|
+
dict[str, Any]: Extracted error attributes (e.g. gcp.errors.domain, error.type, gcp.errors.metadata.*).
|
|
183
|
+
"""
|
|
184
|
+
attrs: dict[str, Any] = {}
|
|
185
|
+
if exc is None:
|
|
186
|
+
return attrs
|
|
187
|
+
|
|
188
|
+
# 1. Unwrap chained exceptions: unwrap RetryError or __cause__ to the root failure
|
|
189
|
+
target_exc = getattr(exc, "cause", None) or getattr(exc, "__cause__", None) or exc
|
|
190
|
+
|
|
191
|
+
# 2. Check GoogleAPICallError ErrorInfo attributes
|
|
192
|
+
error_info = getattr(target_exc, "_error_info", None) or getattr(
|
|
193
|
+
target_exc, "error_info", None
|
|
194
|
+
)
|
|
195
|
+
|
|
196
|
+
# 3. Check native gRPC trailing metadata for binary google.rpc.Status details
|
|
197
|
+
if error_info is None:
|
|
198
|
+
rpc_call = (
|
|
199
|
+
target_exc
|
|
200
|
+
if hasattr(target_exc, "trailing_metadata")
|
|
201
|
+
else getattr(target_exc, "response", None)
|
|
202
|
+
)
|
|
203
|
+
if rpc_call is not None and hasattr(rpc_call, "trailing_metadata"):
|
|
204
|
+
try:
|
|
205
|
+
from google.api_core import exceptions
|
|
206
|
+
|
|
207
|
+
_, error_info = exceptions._parse_grpc_error_details(rpc_call)
|
|
208
|
+
except Exception:
|
|
209
|
+
pass
|
|
210
|
+
|
|
211
|
+
# 4. Unified attribute extraction: extract domain, reason, and metadata from ErrorInfo or exception attributes
|
|
212
|
+
source = error_info or target_exc
|
|
213
|
+
domain = getattr(source, "domain", None)
|
|
214
|
+
if domain:
|
|
215
|
+
attrs["gcp.errors.domain"] = domain
|
|
216
|
+
reason = getattr(source, "reason", None)
|
|
217
|
+
if reason:
|
|
218
|
+
attrs["error.type"] = reason
|
|
219
|
+
metadata = getattr(source, "metadata", None)
|
|
220
|
+
if metadata:
|
|
221
|
+
for k, v in metadata.items():
|
|
222
|
+
attrs[f"gcp.errors.metadata.{k}"] = str(v)
|
|
223
|
+
|
|
224
|
+
return attrs
|
|
225
|
+
|
|
226
|
+
|
|
107
227
|
class _GapicCallable(object):
|
|
108
228
|
"""Callable that applies retry, timeout, and metadata logic.
|
|
109
229
|
|
|
@@ -123,6 +243,18 @@ class _GapicCallable(object):
|
|
|
123
243
|
provided to the RPC method on every invocation. This is merged with
|
|
124
244
|
any metadata specified during invocation. If ``None``, no
|
|
125
245
|
additional metadata will be passed to the RPC method.
|
|
246
|
+
client_options
|
|
247
|
+
(Optional[google.api_core.client_options.ClientOptions]):
|
|
248
|
+
Client options used to configure client-level behavior, such as
|
|
249
|
+
custom OpenTelemetry tracer providers. Defaults to None.
|
|
250
|
+
method_name (Optional[str]): The optional explicit full RPC method name
|
|
251
|
+
(e.g. "/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion").
|
|
252
|
+
is_streaming (bool): Whether the RPC method is streaming. Defaults to False.
|
|
253
|
+
Note: Streaming methods do not currently generate Tier 3 observability spans.
|
|
254
|
+
client_info (Optional[google.api_core.gapic_v1.client_info.ClientInfo]):
|
|
255
|
+
Client information used for metadata headers. Defaults to None.
|
|
256
|
+
kind (str): The transport kind for the RPC method. Defaults to "grpc".
|
|
257
|
+
Allowed values for OpenTelemetry method tracing are "grpc" and "grpc_asyncio".
|
|
126
258
|
"""
|
|
127
259
|
|
|
128
260
|
def __init__(
|
|
@@ -132,22 +264,65 @@ class _GapicCallable(object):
|
|
|
132
264
|
timeout,
|
|
133
265
|
compression,
|
|
134
266
|
metadata=None,
|
|
267
|
+
client_options=None,
|
|
268
|
+
method_name=None,
|
|
269
|
+
is_streaming=False,
|
|
270
|
+
client_info=None,
|
|
271
|
+
kind="grpc",
|
|
135
272
|
):
|
|
136
273
|
self._target = target
|
|
137
274
|
self._retry = retry
|
|
138
275
|
self._timeout = timeout
|
|
139
276
|
self._compression = compression
|
|
277
|
+
|
|
140
278
|
# Pre-extract the x-goog-api-client header from the initialized metadata.
|
|
141
279
|
self._x_goog_api_client, remaining = _extract_metrics_header(metadata)
|
|
142
280
|
self._static_metadata = tuple(remaining)
|
|
143
281
|
if self._x_goog_api_client:
|
|
144
282
|
self._default_metadata = (
|
|
145
|
-
(
|
|
283
|
+
(METRICS_METADATA_KEY, self._x_goog_api_client),
|
|
146
284
|
*self._static_metadata,
|
|
147
285
|
)
|
|
148
286
|
else:
|
|
149
287
|
self._default_metadata = self._static_metadata
|
|
150
288
|
|
|
289
|
+
# Configure the OpenTelemetry span factory once at initialization.
|
|
290
|
+
# For now, method tracing is gated to non-streaming gRPC calls where an explicit method_name is provided.
|
|
291
|
+
self._start_span_fn = None
|
|
292
|
+
if (
|
|
293
|
+
not is_streaming
|
|
294
|
+
and kind == "grpc"
|
|
295
|
+
and method_name is not None
|
|
296
|
+
and _observability.is_otel_capabilities_enabled(client_options)
|
|
297
|
+
):
|
|
298
|
+
try:
|
|
299
|
+
from opentelemetry import trace
|
|
300
|
+
|
|
301
|
+
tracer_provider = None
|
|
302
|
+
if isinstance(client_options, dict):
|
|
303
|
+
tracer_provider = client_options.get("tracer_provider")
|
|
304
|
+
elif client_options is not None:
|
|
305
|
+
tracer_provider = getattr(client_options, "tracer_provider", None)
|
|
306
|
+
if tracer_provider is not None:
|
|
307
|
+
tracer = tracer_provider.get_tracer("google.api_core")
|
|
308
|
+
else:
|
|
309
|
+
tracer = trace.get_tracer("google.api_core")
|
|
310
|
+
|
|
311
|
+
span_name, _, _ = _extract_rpc_identity(method_name)
|
|
312
|
+
span_attributes = {
|
|
313
|
+
"rpc.system.name": "grpc",
|
|
314
|
+
"rpc.method": span_name,
|
|
315
|
+
}
|
|
316
|
+
self._start_span_fn = functools.partial(
|
|
317
|
+
tracer.start_as_current_span,
|
|
318
|
+
span_name,
|
|
319
|
+
kind=trace.SpanKind.CLIENT,
|
|
320
|
+
attributes=span_attributes,
|
|
321
|
+
)
|
|
322
|
+
except (ImportError, AttributeError, TypeError):
|
|
323
|
+
# Gracefully disable tracing if OpenTelemetry or custom provider fails
|
|
324
|
+
self._start_span_fn = None
|
|
325
|
+
|
|
151
326
|
def __call__(
|
|
152
327
|
self, *args, timeout=DEFAULT, retry=DEFAULT, compression=DEFAULT, **kwargs
|
|
153
328
|
):
|
|
@@ -177,7 +352,7 @@ class _GapicCallable(object):
|
|
|
177
352
|
self._x_goog_api_client, user_x_goog
|
|
178
353
|
)
|
|
179
354
|
if merged_header:
|
|
180
|
-
final_metadata.append((
|
|
355
|
+
final_metadata.append((METRICS_METADATA_KEY, merged_header))
|
|
181
356
|
final_metadata.extend(remaining)
|
|
182
357
|
kwargs["metadata"] = final_metadata
|
|
183
358
|
elif self._default_metadata:
|
|
@@ -186,7 +361,27 @@ class _GapicCallable(object):
|
|
|
186
361
|
if self._compression is not None:
|
|
187
362
|
kwargs["compression"] = compression
|
|
188
363
|
|
|
189
|
-
|
|
364
|
+
span_cm = contextlib.nullcontext()
|
|
365
|
+
if self._start_span_fn is not None:
|
|
366
|
+
try:
|
|
367
|
+
span_cm = self._start_span_fn()
|
|
368
|
+
except Exception:
|
|
369
|
+
span_cm = contextlib.nullcontext()
|
|
370
|
+
|
|
371
|
+
with span_cm as span:
|
|
372
|
+
try:
|
|
373
|
+
result = wrapped_func(*args, **kwargs)
|
|
374
|
+
if span is not None and hasattr(span, "set_attribute"):
|
|
375
|
+
span.set_attribute("rpc.response.status_code", "OK")
|
|
376
|
+
return result
|
|
377
|
+
except Exception as exc:
|
|
378
|
+
if span is not None and hasattr(span, "set_attribute"):
|
|
379
|
+
span.set_attribute(
|
|
380
|
+
"rpc.response.status_code", _extract_status_code(exc)
|
|
381
|
+
)
|
|
382
|
+
for k, v in _extract_error_attributes(exc).items():
|
|
383
|
+
span.set_attribute(k, v)
|
|
384
|
+
raise
|
|
190
385
|
|
|
191
386
|
|
|
192
387
|
def wrap_method(
|
|
@@ -197,6 +392,10 @@ def wrap_method(
|
|
|
197
392
|
client_info=client_info.DEFAULT_CLIENT_INFO,
|
|
198
393
|
*,
|
|
199
394
|
with_call=False,
|
|
395
|
+
client_options=None,
|
|
396
|
+
method_name=None,
|
|
397
|
+
is_streaming=False,
|
|
398
|
+
kind="grpc",
|
|
200
399
|
):
|
|
201
400
|
"""Wrap an RPC method with common behavior.
|
|
202
401
|
|
|
@@ -280,6 +479,18 @@ def wrap_method(
|
|
|
280
479
|
return a tuple of (response, grpc.Call) instead of just the response.
|
|
281
480
|
This is useful for extracting trailing metadata from unary calls.
|
|
282
481
|
Defaults to False.
|
|
482
|
+
client_options
|
|
483
|
+
(Optional[google.api_core.client_options.ClientOptions]):
|
|
484
|
+
Client options used to configure client-level behavior, such as
|
|
485
|
+
custom OpenTelemetry tracer providers. Defaults to None.
|
|
486
|
+
method_name (Optional[str]): Optional explicit full RPC method name
|
|
487
|
+
(e.g. "/google.cloud.secretmanager.v1.SecretManagerService/AccessSecretVersion").
|
|
488
|
+
Used to identify the RPC for observability.
|
|
489
|
+
is_streaming (bool): Whether the RPC method is streaming. Defaults to False.
|
|
490
|
+
Streaming methods are currently gated and do not generate Tier 3 spans.
|
|
491
|
+
kind (str): The transport kind for the RPC method. Defaults to "grpc".
|
|
492
|
+
Non-gRPC transports (e.g. "rest") are currently gated and do not generate
|
|
493
|
+
Tier 3 method spans.
|
|
283
494
|
|
|
284
495
|
Returns:
|
|
285
496
|
Callable: A new callable that takes optional ``retry``, ``timeout``,
|
|
@@ -307,5 +518,10 @@ def wrap_method(
|
|
|
307
518
|
default_timeout,
|
|
308
519
|
default_compression,
|
|
309
520
|
metadata=user_agent_metadata,
|
|
521
|
+
client_options=client_options,
|
|
522
|
+
method_name=method_name,
|
|
523
|
+
is_streaming=is_streaming,
|
|
524
|
+
client_info=client_info,
|
|
525
|
+
kind=kind,
|
|
310
526
|
)
|
|
311
527
|
)
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Copyright 2026 Google LLC
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
import os
|
|
16
|
+
import sys
|
|
17
|
+
import types
|
|
18
|
+
from unittest import mock
|
|
19
|
+
|
|
20
|
+
import pytest
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
@pytest.fixture(scope="session", autouse=True)
|
|
24
|
+
def mock_mtls_env():
|
|
25
|
+
"""Autouse session-scoped fixture to isolate unit tests from workstation mTLS environments."""
|
|
26
|
+
with mock.patch.dict(
|
|
27
|
+
os.environ,
|
|
28
|
+
{
|
|
29
|
+
"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false",
|
|
30
|
+
"CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE": "false",
|
|
31
|
+
},
|
|
32
|
+
):
|
|
33
|
+
yield
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
@pytest.fixture
|
|
37
|
+
def mock_otel(monkeypatch):
|
|
38
|
+
"""Provides a mocked OpenTelemetry environment with tracing enabled."""
|
|
39
|
+
monkeypatch.setenv("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", "true")
|
|
40
|
+
mock_span = mock.MagicMock()
|
|
41
|
+
mock_tracer = mock.MagicMock()
|
|
42
|
+
mock_tracer.start_as_current_span.return_value.__enter__.return_value = mock_span
|
|
43
|
+
|
|
44
|
+
mock_trace = mock.Mock()
|
|
45
|
+
mock_trace.get_tracer.return_value = mock_tracer
|
|
46
|
+
mock_trace.SpanKind.CLIENT = "CLIENT"
|
|
47
|
+
mock_trace.StatusCode.ERROR = "ERROR"
|
|
48
|
+
|
|
49
|
+
with (
|
|
50
|
+
mock.patch(
|
|
51
|
+
"google.api_core._observability.is_otel_capabilities_enabled",
|
|
52
|
+
return_value=True,
|
|
53
|
+
),
|
|
54
|
+
mock.patch.dict(
|
|
55
|
+
sys.modules,
|
|
56
|
+
{
|
|
57
|
+
"opentelemetry": mock.Mock(trace=mock_trace),
|
|
58
|
+
"opentelemetry.trace": mock_trace,
|
|
59
|
+
},
|
|
60
|
+
),
|
|
61
|
+
):
|
|
62
|
+
yield types.SimpleNamespace(
|
|
63
|
+
trace=mock_trace,
|
|
64
|
+
tracer=mock_tracer,
|
|
65
|
+
span=mock_span,
|
|
66
|
+
)
|