feat(opentelemetry): add request_tag to span attributes

Author: sinhasubham

google/cloud/spanner_v1/_helpers.py

@@ -35,16 +35,16 @@
 from google.cloud.spanner_v1.data_types import JsonObject, Interval
 from google.cloud.spanner_v1.request_id_header import with_request_id
 from google.cloud.spanner_v1.types import TypeCode
-from opentelemetry.semconv.resource import ResourceAttributes
-from opentelemetry.resourcedetector.gcp_resource_detector import (
-    GoogleCloudResourceDetector,
-)
 
 from google.rpc.error_details_pb2 import RetryInfo
 
 try:
     from opentelemetry.propagate import inject
     from opentelemetry.propagators.textmap import Setter
+    from opentelemetry.semconv.resource import ResourceAttributes
+    from opentelemetry.resourcedetector.gcp_resource_detector import (
+        GoogleCloudResourceDetector,
+    )
 
     HAS_OPENTELEMETRY_INSTALLED = True
 except ImportError:

tests/system/test_session_api.py

@@ -354,6 +354,7 @@ def _make_attributes(db_instance, **kwargs):
         "db.url": "spanner.googleapis.com",
         "net.host.name": "spanner.googleapis.com",
         "db.instance": db_instance,
+        "cloud.region": "global",
         "gcp.client.service": "spanner",
         "gcp.client.version": ot_helpers.LIB_VERSION,
         "gcp.client.repo": "googleapis/python-spanner",

tests/unit/test__opentelemetry_tracing.py

@@ -10,6 +10,7 @@
     pass
 
 from google.api_core.exceptions import GoogleAPICallError
+from google.cloud.spanner_v1._helpers import GOOGLE_CLOUD_REGION_GLOBAL
 from google.cloud.spanner_v1 import _opentelemetry_tracing
 
 from tests._helpers import (
@@ -53,7 +54,8 @@ def test_no_trace_call(self):
                 self.assertIsNone(no_span)
 
     class TestTracing(OpenTelemetryBase):
-        def test_trace_call(self):
+        @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",
                 # Since our database is mocked, we have to override the db.instance parameter so it is a string
@@ -65,7 +67,7 @@ def test_trace_call(self):
                     "db.type": "spanner",
                     "db.url": "spanner.googleapis.com",
                     "net.host.name": "spanner.googleapis.com",
-                    "cloud.region": "global",
+                    "cloud.region": GOOGLE_CLOUD_REGION_GLOBAL,
                     "gcp.client.service": "spanner",
                     "gcp.client.version": LIB_VERSION,
                     "gcp.client.repo": "googleapis/python-spanner",
@@ -88,15 +90,16 @@ def test_trace_call(self):
             self.assertEqual(span.name, "CloudSpanner.Test")
             self.assertEqual(span.status.status_code, StatusCode.OK)
 
-        def test_trace_error(self):
+        @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"}
 
             expected_attributes = enrich_with_otel_scope(
                 {
                     "db.type": "spanner",
                     "db.url": "spanner.googleapis.com",
                     "net.host.name": "spanner.googleapis.com",
-                    "cloud.region": "global",
+                    "cloud.region": GOOGLE_CLOUD_REGION_GLOBAL,
                     "gcp.client.service": "spanner",
                     "gcp.client.version": LIB_VERSION,
                     "gcp.client.repo": "googleapis/python-spanner",

tests/unit/test_batch.py

@@ -30,6 +30,7 @@
     BatchWriteResponse,
     DefaultTransactionOptions,
 )
+import mock
 from google.cloud._helpers import UTC, _datetime_to_pb_timestamp
 import datetime
 from google.api_core.exceptions import Aborted, Unknown
@@ -199,7 +200,8 @@ def test_commit_already_committed(self):
 
         self.assertNoSpans()
 
-    def test_commit_grpc_error(self):
+    @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)
         database = _Database()
@@ -220,7 +222,8 @@ def test_commit_grpc_error(self):
             ),
         )
 
-    def test_commit_ok(self):
+    @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)
         response = CommitResponse(commit_timestamp=now_pb)
@@ -377,35 +380,41 @@ def _test_commit_with_options(
 
         self.assertEqual(max_commit_delay_in, max_commit_delay)
 
-    def test_commit_w_request_tag_success(self):
+    @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)
 
-    def test_commit_w_transaction_tag_success(self):
+    @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)
 
-    def test_commit_w_request_and_transaction_tag_success(self):
+    @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)
 
-    def test_commit_w_request_and_transaction_tag_dictionary_success(self):
+    @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)
 
-    def test_commit_w_incorrect_tag_dictionary_error(self):
+    @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)
 
-    def test_commit_w_max_commit_delay(self):
+    @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",
         )
@@ -414,15 +423,17 @@ def test_commit_w_max_commit_delay(self):
             max_commit_delay_in=datetime.timedelta(milliseconds=100),
         )
 
-    def test_commit_w_exclude_txn_from_change_streams(self):
+    @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",
         )
         self._test_commit_with_options(
             request_options=request_options, exclude_txn_from_change_streams=True
         )
 
-    def test_commit_w_isolation_level(self):
+    @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",
         )
@@ -431,7 +442,8 @@ def test_commit_w_isolation_level(self):
             isolation_level=TransactionOptions.IsolationLevel.REPEATABLE_READ,
         )
 
-    def test_commit_w_read_lock_mode(self):
+    @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",
         )
@@ -440,7 +452,8 @@ def test_commit_w_read_lock_mode(self):
             read_lock_mode=TransactionOptions.ReadWrite.ReadLockMode.OPTIMISTIC,
         )
 
-    def test_commit_w_isolation_level_and_read_lock_mode(self):
+    @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",
         )
@@ -450,7 +463,8 @@ def test_commit_w_isolation_level_and_read_lock_mode(self):
             read_lock_mode=TransactionOptions.ReadWrite.ReadLockMode.PESSIMISTIC,
         )
 
-    def test_context_mgr_already_committed(self):
+    @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()
         api = database.spanner_api = _FauxSpannerAPI()
@@ -464,7 +478,8 @@ def test_context_mgr_already_committed(self):
 
         self.assertEqual(api._committed, None)
 
-    def test_context_mgr_success(self):
+    @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)
         response = CommitResponse(commit_timestamp=now_pb)
@@ -511,7 +526,8 @@ def test_context_mgr_success(self):
             ),
         )
 
-    def test_context_mgr_failure(self):
+    @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)
         response = CommitResponse(commit_timestamp=now_pb)
@@ -542,7 +558,8 @@ def test_ctor(self):
         groups = self._make_one(session)
         self.assertIs(groups._session, session)
 
-    def test_batch_write_already_committed(self):
+    @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)
         database = _Database()
@@ -565,7 +582,8 @@ def test_batch_write_already_committed(self):
         with self.assertRaises(ValueError):
             groups.batch_write()
 
-    def test_batch_write_grpc_error(self):
+    @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)
         database = _Database()
@@ -663,25 +681,31 @@ def _test_batch_write_with_request_options(
             ),
         )
 
-    def test_batch_write_no_request_options(self):
+    @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()
 
-    def test_batch_write_end_to_end_tracing_enabled(self):
+    @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)
 
-    def test_batch_write_w_transaction_tag_success(self):
+    @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")
         )
 
-    def test_batch_write_w_transaction_tag_dictionary_success(self):
+    @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"})
 
-    def test_batch_write_w_incorrect_tag_dictionary_error(self):
+    @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"})
 
-    def test_batch_write_w_exclude_txn_from_change_streams(self):
+    @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
         )