Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

feat: add Cloud Trace adoption attributes #1374

Merged
cojenco merged 2 commits into from
Nov 7, 2024
Merged

feat: add Cloud Trace adoption attributes #1374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3ef7bb
chore: add Cloud Trace adoption attributes
cojenco Nov 1, 2024
71c3444
Merge branch 'main' into trace-adopt-attrs
cojenco Nov 7, 2024
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
7 changes: 7 additions & 0 deletions google/cloud/storage/_opentelemetry_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@
"user_agent.original": f"gcloud-python/{__version__}",
}

_cloud_trace_adoption_attrs = {
"gcp.client.service": "storage",
"gcp.client.version": __version__,
"gcp.client.repo": "googleapis/python-storage",
}


@contextmanager
def create_trace_span(name, attributes=None, client=None, api_request=None, retry=None):
Expand All @@ -79,6 +85,7 @@ def create_trace_span(name, attributes=None, client=None, api_request=None, retr

def _get_final_attributes(attributes=None, client=None, api_request=None, retry=None):
collected_attr = _default_attributes.copy()
collected_attr.update(_cloud_trace_adoption_attrs)
if api_request:
collected_attr.update(_set_api_request_attr(api_request, client))
if isinstance(retry, api_retry.Retry):
Expand Down
23 changes: 9 additions & 14 deletions tests/unit/test__opentelemetry_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,8 @@ def test_enable_trace_call(setup, setup_optin):
extra_attributes = {
"attribute1": "value1",
}
expected_attributes = {
"rpc.service": "CloudStorage",
"rpc.system": "http",
"user_agent.original": f"gcloud-python/{__version__}",
}
expected_attributes = _opentelemetry_tracing._default_attributes.copy()
expected_attributes.update(_opentelemetry_tracing._cloud_trace_adoption_attrs)
expected_attributes.update(extra_attributes)

with _opentelemetry_tracing.create_trace_span(
Expand All @@ -114,11 +111,8 @@ def test_enable_trace_error(setup, setup_optin):
extra_attributes = {
"attribute1": "value1",
}
expected_attributes = {
"rpc.service": "CloudStorage",
"rpc.system": "http",
"user_agent.original": f"gcloud-python/{__version__}",
}
expected_attributes = _opentelemetry_tracing._default_attributes.copy()
expected_attributes.update(_opentelemetry_tracing._cloud_trace_adoption_attrs)
expected_attributes.update(extra_attributes)

with pytest.raises(GoogleAPICallError):
Expand Down Expand Up @@ -157,6 +151,7 @@ def test_get_final_attributes(setup, setup_optin):
"connect_timeout,read_timeout": (100, 100),
"retry": f"multiplier{retry_obj._multiplier}/deadline{retry_obj._deadline}/max{retry_obj._maximum}/initial{retry_obj._initial}/predicate{retry_obj._predicate}",
}
expected_attributes.update(_opentelemetry_tracing._cloud_trace_adoption_attrs)

with mock.patch("google.cloud.storage.client.Client") as test_client:
test_client.project = "test_project"
Expand Down Expand Up @@ -185,12 +180,12 @@ def test_set_conditional_retry_attr(setup, setup_optin):
retry_policy, conditional_predicate, required_kwargs
)

expected_attributes = {
"rpc.service": "CloudStorage",
"rpc.system": "http",
"user_agent.original": f"gcloud-python/{__version__}",
retry_attrs = {
"retry": f"multiplier{retry_policy._multiplier}/deadline{retry_policy._deadline}/max{retry_policy._maximum}/initial{retry_policy._initial}/predicate{conditional_predicate}",
}
expected_attributes = _opentelemetry_tracing._default_attributes.copy()
expected_attributes.update(_opentelemetry_tracing._cloud_trace_adoption_attrs)
expected_attributes.update(retry_attrs)

with _opentelemetry_tracing.create_trace_span(
test_span_name,
Expand Down