-
Notifications
You must be signed in to change notification settings - Fork 1.8k
experiment(secretmanager): Otel tracing prototype in google-cloud-secretmanager #18086
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
f2ecbc0
f8e5f4c
49a88ff
73f91fe
ca1559b
6c3cca8
8297044
d019dd3
182da98
061fdaa
9aa3a00
0309a90
97ded5a
939feeb
40f7023
fc56170
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,9 +24,8 @@ | |
| from typing import AsyncGenerator, Generic, Iterator, Optional, TypeVar | ||
|
|
||
| import grpc | ||
| from grpc import aio | ||
|
|
||
| from google.api_core import exceptions, general_helpers, grpc_helpers | ||
| from grpc import aio | ||
|
|
||
| # denotes the proto response type for grpc calls | ||
| P = TypeVar("P") | ||
|
|
@@ -303,6 +302,15 @@ def create_channel( | |
| if attempt_direct_path: | ||
| target = grpc_helpers._modify_target_for_direct_path(target) | ||
|
|
||
| # NOTE: 'configuration' is popped to prevent a TypeError. | ||
| # Generated async transports (like those in google-cloud-* libs) pass 'configuration' | ||
| # down to this helper via **kwargs to support tracing in sync transports. | ||
| # However, 'aio.secure_channel' does not recognize this parameter yet and will | ||
| # crash if it is passed through. | ||
| # Async gRPC tracing is deferred to a future phase/PR, so we simply discard | ||
| # this parameter for now to ensure generated async code doesn't fail at runtime. | ||
| kwargs.pop("configuration", None) | ||
|
Comment on lines
+305
to
+312
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Instead of manually popping |
||
|
|
||
| return aio.secure_channel( | ||
| target, composite_credentials, compression=compression, **kwargs | ||
| ) | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,3 +12,4 @@ requests==2.33.0 | |
| grpcio==1.59.0 | ||
| grpcio-status==1.59.0 | ||
| proto-plus==1.26.1 | ||
| opentelemetry-api==1.27.0 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,3 +13,4 @@ grpcio==1.59.0 | |
| grpcio-status==1.59.0 | ||
| proto-plus==1.26.1 | ||
| aiohttp==3.13.4 | ||
| opentelemetry-api==1.27.0 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,7 +33,6 @@ | |
|
|
||
|
|
||
| import google.auth.credentials | ||
|
|
||
| from google.api_core import exceptions, grpc_helpers_async | ||
|
|
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| """Tests for OpenTelemetry gRPC interceptor integration in google-api-core.""" | ||
|
|
||
| import sys | ||
| import types | ||
| from unittest import mock | ||
|
|
||
| import pytest | ||
|
|
||
| try: | ||
| from google.api_core import grpc_helpers | ||
|
|
||
| HAS_GRPC_HELPERS = True | ||
| except ImportError: | ||
| HAS_GRPC_HELPERS = False | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def mock_otel_grpc(monkeypatch): | ||
| """Fixture to mock OpenTelemetry gRPC hierarchy.""" | ||
| mock_otel = mock.Mock() | ||
| mock_otel_grpc = mock_otel.instrumentation.grpc | ||
| mock_interceptor = mock.Mock() | ||
| mock_otel_grpc.client_interceptor.return_value = mock_interceptor | ||
|
|
||
| modules = { | ||
| "opentelemetry": mock_otel, | ||
| "opentelemetry.instrumentation": mock_otel.instrumentation, | ||
| "opentelemetry.instrumentation.grpc": mock_otel_grpc, | ||
| } | ||
|
|
||
| for name, mod in modules.items(): | ||
| monkeypatch.setitem(sys.modules, name, mod) | ||
|
|
||
| return mock_otel_grpc | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "is_otel_installed, tracing_env_var_value, expect_otel_interceptor", | ||
| [ | ||
| pytest.param(True, "true", True, id="installed_and_enabled"), | ||
| pytest.param(True, "false", False, id="installed_but_disabled"), | ||
| pytest.param(False, "true", False, id="not_installed_fails_open"), | ||
| ], | ||
| ) | ||
| @pytest.mark.skipif(not HAS_GRPC_HELPERS, reason="Requires google-api-core[grpc]") | ||
| def test_create_channel_otel_combos( | ||
| monkeypatch, | ||
| mock_otel_grpc, | ||
| is_otel_installed, | ||
| tracing_env_var_value, | ||
| expect_otel_interceptor, | ||
| ): | ||
| """Verify create_channel behavior with various OTel installation and enablement states.""" | ||
|
|
||
| monkeypatch.setenv("GOOGLE_CLOUD_PYTHON_TRACING_ENABLED", tracing_env_var_value) | ||
|
|
||
| if not is_otel_installed: | ||
| monkeypatch.setitem(sys.modules, "opentelemetry.instrumentation.grpc", None) | ||
|
|
||
| mock_channel = "raw_channel" | ||
| with ( | ||
| mock.patch( | ||
| "grpc.secure_channel", return_value=mock_channel | ||
| ) as mock_secure_channel, | ||
| mock.patch( | ||
| "grpc.intercept_channel", side_effect=lambda ch, inc: f"wrapped_{ch}" | ||
| ) as mock_intercept_channel, | ||
| ): | ||
| with mock.patch( | ||
| "google.api_core.grpc_helpers._create_composite_credentials", | ||
| return_value=mock.Mock(), | ||
| ): | ||
| channel = grpc_helpers.create_channel("localhost:1234") | ||
|
|
||
| # Always expect raw channel creation | ||
| mock_secure_channel.assert_called_once() | ||
|
|
||
| if expect_otel_interceptor: | ||
| mock_otel_grpc.client_interceptor.assert_called_once() | ||
| mock_intercept_channel.assert_called_once_with( | ||
| mock_channel, mock_otel_grpc.client_interceptor.return_value | ||
| ) | ||
| assert channel == f"wrapped_{mock_channel}" | ||
| else: | ||
| # OTel should NOT have been called | ||
| mock_intercept_channel.assert_not_called() | ||
| assert channel == mock_channel | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "config_factory", | ||
| [ | ||
| lambda tp: {"tracer_provider": tp}, | ||
| lambda tp: types.SimpleNamespace(tracer_provider=tp), | ||
| ], | ||
| ids=["dict", "object"], | ||
| ) | ||
| @pytest.mark.skipif(not HAS_GRPC_HELPERS, reason="Requires google-api-core[grpc]") | ||
| def test_create_channel_with_custom_tracer_provider( | ||
| monkeypatch, mock_otel_grpc, config_factory | ||
| ): | ||
| """Verify that create_channel passes custom tracer_provider to OTel interceptor.""" | ||
|
|
||
| mock_tracer_provider = mock.Mock() | ||
| config = config_factory(mock_tracer_provider) | ||
|
|
||
| mock_channel = "raw_channel" | ||
| with ( | ||
| mock.patch("grpc.secure_channel", return_value=mock_channel), | ||
| mock.patch( | ||
| "grpc.intercept_channel", side_effect=lambda ch, inc: f"wrapped_{ch}" | ||
| ), | ||
| ): | ||
| with mock.patch( | ||
| "google.api_core.grpc_helpers._create_composite_credentials", | ||
| return_value=mock.Mock(), | ||
| ): | ||
| grpc_helpers.create_channel("localhost:1234", configuration=config) | ||
|
|
||
| mock_otel_grpc.client_interceptor.assert_called_once_with( | ||
| tracer_provider=mock_tracer_provider | ||
| ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of popping
configurationfromkwargshere, consider addingconfiguration: Optional[object] = Noneas an explicit parameter to thecreate_channelfunction signature. This makes the parameter explicit, improves discoverability, and allows static analysis tools to type-check it properly.