Skip to content

feat(observability): suppress redundant gRPC auto-instrumentation spans #18592

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
chalmerlowe wants to merge 8 commits into
base: main
Choose a base branch
from
+999 −354
Draft

feat(observability): suppress redundant gRPC auto-instrumentation spans #18592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6b941c8
feat(observability): suppress redundant gRPC auto-instrumentation spans
chalmerlowe Oct 15, 2026
a22fab7
refactor(observability): simplify template comments and parametrize a…
chalmerlowe Oct 15, 2026
7438abc
test(observability): simplify parametrization for inactive async chan…
chalmerlowe Oct 15, 2026
c764cf6
Apply suggestion from @chalmerlowe
chalmerlowe Oct 16, 2026
b07bf58
update version number
chalmerlowe Oct 16, 2026
d89f534
update version number
chalmerlowe Oct 16, 2026
845883e
Update comment
chalmerlowe Oct 16, 2026
79645c5
refactor(observability): consolidate grpc interceptor imports and fal…
chalmerlowe Oct 16, 2026
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
16 changes: 10 additions & 6 deletions .../templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,21 +333,25 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
14 changes: 6 additions & 8 deletions .../gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1045,20 +1045,19 @@ def test_{{ service.name|snake_case }}_grpc_asyncio_transport_channel_intercepto


@pytest.mark.skipif(
_observability is None,
reason="Requires google-api-core with OpenTelemetry support (>= 2.36.0)",
_observability is None or not hasattr(_observability, "apply_otel_async_channel_interceptors"),
reason="Requires google-api-core with OpenTelemetry async channel interceptors support (>= v2.43.0)",
)
def test_{{ service.name|snake_case }}_grpc_asyncio_transport_otel_channel_interceptor():
mock_otel_interceptor = mock.Mock()
mock_channel = mock.Mock()
mock_channel._unary_unary_interceptors = []

with (
mock.patch.object(
_observability,
"get_otel_async_interceptor",
return_value=mock_otel_interceptor,
) as mock_get_async_interceptor,
"apply_otel_async_channel_interceptors",
return_value=mock_channel,
) as mock_apply_async_interceptors,
mock.patch.object(
transports.{{ service.grpc_asyncio_transport_name }},
"create_channel",
Expand All @@ -1071,9 +1070,8 @@ def test_{{ service.name|snake_case }}_grpc_asyncio_transport_otel_channel_inter
client_options=options,
)

mock_get_async_interceptor.assert_called_once_with(options)
mock_apply_async_interceptors.assert_called_once_with(mock_channel, options)
assert mock_create_channel.call_count == 1
assert mock_otel_interceptor in transport.grpc_channel._unary_unary_interceptors
assert transport.grpc_channel == mock_channel


Expand Down
16 changes: 10 additions & 6 deletions ...ion/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,21 +319,25 @@ def __init__(self, *,
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= 2.36.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
14 changes: 6 additions & 8 deletions ...generator/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -900,20 +900,19 @@ def test_asset_service_grpc_asyncio_transport_channel_interceptors():


@pytest.mark.skipif(
_observability is None,
reason="Requires google-api-core with OpenTelemetry support (>= 2.36.0)",
_observability is None or not hasattr(_observability, "apply_otel_async_channel_interceptors"),
reason="Requires google-api-core with OpenTelemetry async channel interceptors support",
)
def test_asset_service_grpc_asyncio_transport_otel_channel_interceptor():
mock_otel_interceptor = mock.Mock()
mock_channel = mock.Mock()
mock_channel._unary_unary_interceptors = []

with (
mock.patch.object(
_observability,
"get_otel_async_interceptor",
return_value=mock_otel_interceptor,
) as mock_get_async_interceptor,
"apply_otel_async_channel_interceptors",
return_value=mock_channel,
) as mock_apply_async_interceptors,
mock.patch.object(
transports.AssetServiceGrpcAsyncIOTransport,
"create_channel",
Expand All @@ -926,9 +925,8 @@ def test_asset_service_grpc_asyncio_transport_otel_channel_interceptor():
client_options=options,
)

mock_get_async_interceptor.assert_called_once_with(options)
mock_apply_async_interceptors.assert_called_once_with(mock_channel, options)
assert mock_create_channel.call_count == 1
assert mock_otel_interceptor in transport.grpc_channel._unary_unary_interceptors
assert transport.grpc_channel == mock_channel


Expand Down
16 changes: 10 additions & 6 deletions ...credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,21 +324,25 @@ def __init__(self, *,
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= 2.36.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
14 changes: 6 additions & 8 deletions ...s/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,20 +890,19 @@ def test_iam_credentials_grpc_asyncio_transport_channel_interceptors():


@pytest.mark.skipif(
_observability is None,
reason="Requires google-api-core with OpenTelemetry support (>= 2.36.0)",
_observability is None or not hasattr(_observability, "apply_otel_async_channel_interceptors"),
reason="Requires google-api-core with OpenTelemetry async channel interceptors support",
)
def test_iam_credentials_grpc_asyncio_transport_otel_channel_interceptor():
mock_otel_interceptor = mock.Mock()
mock_channel = mock.Mock()
mock_channel._unary_unary_interceptors = []

with (
mock.patch.object(
_observability,
"get_otel_async_interceptor",
return_value=mock_otel_interceptor,
) as mock_get_async_interceptor,
"apply_otel_async_channel_interceptors",
return_value=mock_channel,
) as mock_apply_async_interceptors,
mock.patch.object(
transports.IAMCredentialsGrpcAsyncIOTransport,
"create_channel",
Expand All @@ -916,9 +915,8 @@ def test_iam_credentials_grpc_asyncio_transport_otel_channel_interceptor():
client_options=options,
)

mock_get_async_interceptor.assert_called_once_with(options)
mock_apply_async_interceptors.assert_called_once_with(mock_channel, options)
assert mock_create_channel.call_count == 1
assert mock_otel_interceptor in transport.grpc_channel._unary_unary_interceptors
assert transport.grpc_channel == mock_channel


Expand Down
16 changes: 10 additions & 6 deletions ...on/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,21 +333,25 @@ def __init__(self, *,
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= 2.36.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
14 changes: 6 additions & 8 deletions ...enerator/tests/integration/goldens/eventarc/tests/unit/gapic/eventarc_v1/test_eventarc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,20 +921,19 @@ def test_eventarc_grpc_asyncio_transport_channel_interceptors():


@pytest.mark.skipif(
_observability is None,
reason="Requires google-api-core with OpenTelemetry support (>= 2.36.0)",
_observability is None or not hasattr(_observability, "apply_otel_async_channel_interceptors"),
reason="Requires google-api-core with OpenTelemetry async channel interceptors support",
)
def test_eventarc_grpc_asyncio_transport_otel_channel_interceptor():
mock_otel_interceptor = mock.Mock()
mock_channel = mock.Mock()
mock_channel._unary_unary_interceptors = []

with (
mock.patch.object(
_observability,
"get_otel_async_interceptor",
return_value=mock_otel_interceptor,
) as mock_get_async_interceptor,
"apply_otel_async_channel_interceptors",
return_value=mock_channel,
) as mock_apply_async_interceptors,
mock.patch.object(
transports.EventarcGrpcAsyncIOTransport,
"create_channel",
Expand All @@ -947,9 +946,8 @@ def test_eventarc_grpc_asyncio_transport_otel_channel_interceptor():
client_options=options,
)

mock_get_async_interceptor.assert_called_once_with(options)
mock_apply_async_interceptors.assert_called_once_with(mock_channel, options)
assert mock_create_channel.call_count == 1
assert mock_otel_interceptor in transport.grpc_channel._unary_unary_interceptors
assert transport.grpc_channel == mock_channel


Expand Down
16 changes: 10 additions & 6 deletions ...ens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,21 +319,25 @@ def __init__(self, *,
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= 2.36.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
16 changes: 10 additions & 6 deletions ...ns/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,21 +317,25 @@ def __init__(self, *,
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= 2.36.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
16 changes: 10 additions & 6 deletions ...ns/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,21 +317,25 @@ def __init__(self, *,
],
)

# Wrap channel with user-specified and logging interceptors.
channel_interceptors = list(interceptors) if interceptors else []
self._interceptor = _LoggingClientAIOInterceptor()
channel_interceptors.append(self._interceptor)
self._grpc_channel = apply_async_channel_interceptors(
self._grpc_channel, channel_interceptors
)

# Configure OpenTelemetry tracing and span suppression on the channel.
if (
_observability is not None
and (otel_interceptors := _observability.get_otel_async_interceptor(self._client_options)) is not None
and hasattr(_observability, "apply_otel_async_channel_interceptors")
):
# NOTE: Coverage tool ignores async interceptors in environments running
# legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable.
# Lifecycle: Can be lifted once lowest constraints require google-api-core >= 2.36.0.
otel_list = otel_interceptors if isinstance(otel_interceptors, (list, tuple)) else [otel_interceptors] # pragma: NO COVER
channel_interceptors.extend(otel_list) # pragma: NO COVER

self._grpc_channel = apply_async_channel_interceptors(self._grpc_channel, channel_interceptors)
# TODO (Issue #18657): Remove once lowest constraints require google-api-core >= 2.36.0.
self._grpc_channel = _observability.apply_otel_async_channel_interceptors(
self._grpc_channel, self._client_options
) # pragma: NO COVER

self._logged_channel = self._grpc_channel
# Wrap messages. This must be done after self._logged_channel exists
Expand Down
Loading
Loading