Skip to content

feat: add cloud.region, request_tag and transaction_tag in span attributes #1449

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

Merged
sinhasubham merged 8 commits into from
Nov 12, 2025
Merged

feat: add cloud.region, request_tag and transaction_tag in span attributes #1449

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e49afa6
feat: add cloud.region and transaction_tag in span attributes
sinhasubham Oct 27, 2025
af65849
feat(opentelemetry): add request_tag to span attributes
sinhasubham Oct 27, 2025
db90a47
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Oct 27, 2025
1bd0a2c
feat(opentelemetry): add request_tag to span attributes
sinhasubham Oct 27, 2025
f75e31c
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Oct 28, 2025
f3bf074
feat(opentelemetry): add request_tag to span attributes
sinhasubham Oct 27, 2025
2ff6bf1
Merge branch 'main' into fix/span-attributes
sinhasubham Nov 11, 2025
8341833
Merge branch 'main' into fix/span-attributes
surbhigarg92 Nov 12, 2025
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
Prev Previous commit
Next Next commit
🦉 Updates from OwlBot post-processor 
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] committed Oct 28, 2025
commit f75e31c53d43cad5574b80838e2f190c537f022a
10 changes: 8 additions & 2 deletions tests/unit/test__opentelemetry_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ def test_no_trace_call(self):
self.assertIsNone(no_span)

class TestTracing(OpenTelemetryBase):
@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_trace_call(self, mock_region):
extra_attributes = {
"attribute1": "value1",
Expand Down Expand Up @@ -90,7 +93,10 @@ def test_trace_call(self, mock_region):
self.assertEqual(span.name, "CloudSpanner.Test")
self.assertEqual(span.status.status_code, StatusCode.OK)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_trace_error(self, mock_region):
extra_attributes = {"db.instance": "database_name"}

Expand Down
115 changes: 92 additions & 23 deletions tests/unit/test_batch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,10 @@ def test_commit_already_committed(self):

self.assertNoSpans()

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_grpc_error(self, mock_region):
keys = [[0], [1], [2]]
keyset = KeySet(keys=keys)
Expand All @@ -222,7 +225,10 @@ def test_commit_grpc_error(self, mock_region):
),
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_ok(self, mock_region):
now = datetime.datetime.utcnow().replace(tzinfo=UTC)
now_pb = _datetime_to_pb_timestamp(now)
Expand Down Expand Up @@ -380,40 +386,58 @@ def _test_commit_with_options(

self.assertEqual(max_commit_delay_in, max_commit_delay)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_request_tag_success(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
)
self._test_commit_with_options(request_options=request_options)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_transaction_tag_success(self, mock_region):
request_options = RequestOptions(
transaction_tag="tag-1-1",
)
self._test_commit_with_options(request_options=request_options)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_request_and_transaction_tag_success(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
transaction_tag="tag-1-1",
)
self._test_commit_with_options(request_options=request_options)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_request_and_transaction_tag_dictionary_success(self, mock_region):
request_options = {"request_tag": "tag-1", "transaction_tag": "tag-1-1"}
self._test_commit_with_options(request_options=request_options)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_incorrect_tag_dictionary_error(self, mock_region):
request_options = {"incorrect_tag": "tag-1-1"}
with self.assertRaises(ValueError):
self._test_commit_with_options(request_options=request_options)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_max_commit_delay(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
Expand All @@ -423,7 +447,10 @@ def test_commit_w_max_commit_delay(self, mock_region):
max_commit_delay_in=datetime.timedelta(milliseconds=100),
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_exclude_txn_from_change_streams(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
Expand All @@ -432,7 +459,10 @@ def test_commit_w_exclude_txn_from_change_streams(self, mock_region):
request_options=request_options, exclude_txn_from_change_streams=True
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_isolation_level(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
Expand All @@ -442,7 +472,10 @@ def test_commit_w_isolation_level(self, mock_region):
isolation_level=TransactionOptions.IsolationLevel.REPEATABLE_READ,
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_read_lock_mode(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
Expand All @@ -452,7 +485,10 @@ def test_commit_w_read_lock_mode(self, mock_region):
read_lock_mode=TransactionOptions.ReadWrite.ReadLockMode.OPTIMISTIC,
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_commit_w_isolation_level_and_read_lock_mode(self, mock_region):
request_options = RequestOptions(
request_tag="tag-1",
Expand All @@ -463,7 +499,10 @@ def test_commit_w_isolation_level_and_read_lock_mode(self, mock_region):
read_lock_mode=TransactionOptions.ReadWrite.ReadLockMode.PESSIMISTIC,
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_context_mgr_already_committed(self, mock_region):
now = datetime.datetime.utcnow().replace(tzinfo=UTC)
database = _Database()
Expand All @@ -478,7 +517,10 @@ def test_context_mgr_already_committed(self, mock_region):

self.assertEqual(api._committed, None)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_context_mgr_success(self, mock_region):
now = datetime.datetime.utcnow().replace(tzinfo=UTC)
now_pb = _datetime_to_pb_timestamp(now)
Expand Down Expand Up @@ -526,7 +568,10 @@ def test_context_mgr_success(self, mock_region):
),
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_context_mgr_failure(self, mock_region):
now = datetime.datetime.utcnow().replace(tzinfo=UTC)
now_pb = _datetime_to_pb_timestamp(now)
Expand Down Expand Up @@ -558,7 +603,10 @@ def test_ctor(self):
groups = self._make_one(session)
self.assertIs(groups._session, session)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_already_committed(self, mock_region):
keys = [[0], [1], [2]]
keyset = KeySet(keys=keys)
Expand All @@ -582,7 +630,10 @@ def test_batch_write_already_committed(self, mock_region):
with self.assertRaises(ValueError):
groups.batch_write()

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_grpc_error(self, mock_region):
keys = [[0], [1], [2]]
keyset = KeySet(keys=keys)
Expand Down Expand Up @@ -681,30 +732,48 @@ def _test_batch_write_with_request_options(
),
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_no_request_options(self, mock_region):
self._test_batch_write_with_request_options()

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_end_to_end_tracing_enabled(self, mock_region):
self._test_batch_write_with_request_options(enable_end_to_end_tracing=True)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_w_transaction_tag_success(self, mock_region):
self._test_batch_write_with_request_options(
RequestOptions(transaction_tag="tag-1-1")
)

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_w_transaction_tag_dictionary_success(self, mock_region):
self._test_batch_write_with_request_options({"transaction_tag": "tag-1-1"})

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_w_incorrect_tag_dictionary_error(self, mock_region):
with self.assertRaises(ValueError):
self._test_batch_write_with_request_options({"incorrect_tag": "tag-1-1"})

@mock.patch("google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region", return_value="global")
@mock.patch(
"google.cloud.spanner_v1._opentelemetry_tracing._get_cloud_region",
return_value="global",
)
def test_batch_write_w_exclude_txn_from_change_streams(self, mock_region):
self._test_batch_write_with_request_options(
exclude_txn_from_change_streams=True
Expand Down
Loading
Loading