Skip to content

fix(gapic-generator): default client_options.api_endpoint to transport host for OpenTelemetry spans #18869

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 1 commit into
base: fix/otel-http-t3-t4-attributes
Choose a base branch
from
Draft

fix(gapic-generator): default client_options.api_endpoint to transport host for OpenTelemetry spans #18869

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions ...or/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ class {{ service.name }}Transport(abc.ABC):
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
Comment on lines +165 to +168

@gemini-code-assist gemini-code-assist Bot Oct 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Mutating the client_options argument in-place (whether it is a ClientOptions instance or a dict) can lead to unexpected side effects if the caller reuses the same options object across multiple client or transport instances. To prevent this, we should create a copy of the options before modifying them.

        if isinstance(client_options, client_options_lib.ClientOptions):
            if not client_options.api_endpoint:
                import copy
                client_options = copy.copy(client_options)
                client_options.api_endpoint = self._host
        elif isinstance(client_options, dict):
            if not client_options.get("api_endpoint"):
                client_options = dict(client_options)
                client_options["api_endpoint"] = self._host

self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion .../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 @@ -2489,9 +2489,18 @@ def test_{{ service.name|snake_case }}_base_transport_wrap_method_modern_api_cor

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.{{ service.name }}Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.{{ service.name }}Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...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 @@ -18424,9 +18424,18 @@ def test_asset_service_base_transport_wrap_method_modern_api_core(monkeypatch):

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.AssetServiceTransport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.AssetServiceTransport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...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 @@ -4470,9 +4470,18 @@ def test_iam_credentials_base_transport_wrap_method_modern_api_core(monkeypatch)

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.IAMCredentialsTransport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.IAMCredentialsTransport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...ntegration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...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 @@ -33527,9 +33527,18 @@ def test_eventarc_base_transport_wrap_method_modern_api_core(monkeypatch):

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.EventarcTransport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.EventarcTransport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...ion/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
4 changes: 4 additions & 0 deletions ...on/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
4 changes: 4 additions & 0 deletions ...on/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...r/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14021,9 +14021,18 @@ def test_config_service_v2_base_transport_wrap_method_modern_api_core(monkeypatc

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.ConfigServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.ConfigServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
11 changes: 10 additions & 1 deletion .../tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4461,9 +4461,18 @@ def test_logging_service_v2_base_transport_wrap_method_modern_api_core(monkeypat

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.LoggingServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.LoggingServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
11 changes: 10 additions & 1 deletion .../tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4261,9 +4261,18 @@ def test_metrics_service_v2_base_transport_wrap_method_modern_api_core(monkeypat

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.MetricsServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.MetricsServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...ns/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
4 changes: 4 additions & 0 deletions ...s/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
4 changes: 4 additions & 0 deletions ...s/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...ntegration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_config_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14021,9 +14021,18 @@ def test_config_service_v2_base_transport_wrap_method_modern_api_core(monkeypatc

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.ConfigServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.ConfigServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
11 changes: 10 additions & 1 deletion ...tegration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_logging_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4461,9 +4461,18 @@ def test_logging_service_v2_base_transport_wrap_method_modern_api_core(monkeypat

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.LoggingServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.LoggingServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
11 changes: 10 additions & 1 deletion ...tegration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_metrics_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4261,9 +4261,18 @@ def test_metrics_service_v2_base_transport_wrap_method_modern_api_core(monkeypat

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.MetricsServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.MetricsServiceV2Transport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...s/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...c-generator/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13315,9 +13315,18 @@ def test_cloud_redis_base_transport_wrap_method_modern_api_core(monkeypatch):

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.CloudRedisTransport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.CloudRedisTransport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...ion/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
11 changes: 10 additions & 1 deletion ...r/tests/integration/goldens/redis_selective/tests/unit/gapic/redis_v1/test_cloud_redis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8535,9 +8535,18 @@ def test_cloud_redis_base_transport_wrap_method_modern_api_core(monkeypatch):

# 2. Base transport: kind raises NotImplementedError and is cleanly omitted
with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap:
options = client_options.ClientOptions()
base_transport = transports.CloudRedisTransport(
credentials=ga_credentials.AnonymousCredentials()
credentials=ga_credentials.AnonymousCredentials(),
client_options=options,
)
assert base_transport._client_options.api_endpoint == base_transport._host
dict_options = {}
dict_transport = transports.CloudRedisTransport(
credentials=ga_credentials.AnonymousCredentials(),
client_options=dict_options,
)
assert dict_transport._client_options["api_endpoint"] == dict_transport._host
func = mock.MagicMock()
base_transport._wrap_method(func)
assert "kind" not in mock_wrap.call_args.kwargs
Expand Down
4 changes: 4 additions & 0 deletions ...sts/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
4 changes: 4 additions & 0 deletions ...integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ def __init__(
host += ':443'
self._host = host

if isinstance(client_options, client_options_lib.ClientOptions) and not client_options.api_endpoint:
client_options.api_endpoint = self._host
elif isinstance(client_options, dict) and not client_options.get("api_endpoint"):
client_options["api_endpoint"] = self._host
self._client_options = client_options
self._wrapped_methods: Dict[Callable, Callable] = {}

Expand Down
Loading
Loading