feat: add GCP standard otel attributes for python client (#1308)

* chore: add standard otel attributes for GCP python client lib * chore: test fixes * chore: fix tests * chore: test fix * chore: test fixes

Author: harshachinta

google/cloud/spanner_v1/_opentelemetry_tracing.py

@@ -93,6 +93,10 @@ def trace_call(name, session=None, extra_attributes=None, observability_options=
  "net.host.name": SpannerClient.DEFAULT_ENDPOINT,
  OTEL_SCOPE_NAME: TRACER_NAME,
  OTEL_SCOPE_VERSION: TRACER_VERSION,
+ # Standard GCP attributes for OTel, attributes are used for internal purpose and are subjected to change
+ "gcp.client.service": "spanner",
+ "gcp.client.version": TRACER_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
 
  if extra_attributes:

tests/system/test_session_api.py

@@ -345,6 +345,9 @@ def _make_attributes(db_instance, **kwargs):
  "db.url": "spanner.googleapis.com",
  "net.host.name": "spanner.googleapis.com",
  "db.instance": db_instance,
+ "gcp.client.service": "spanner",
+ "gcp.client.version": ot_helpers.LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  ot_helpers.enrich_with_otel_scope(attributes)
 

tests/unit/test__opentelemetry_tracing.py

@@ -14,6 +14,7 @@
 
 from tests._helpers import (
  OpenTelemetryBase,
+ LIB_VERSION,
  HAS_OPENTELEMETRY_INSTALLED,
  enrich_with_otel_scope,
 )
@@ -64,6 +65,9 @@ def test_trace_call(self):
  "db.type": "spanner",
  "db.url": "spanner.googleapis.com",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  )
  expected_attributes.update(extra_attributes)
@@ -91,6 +95,9 @@ def test_trace_error(self):
  "db.type": "spanner",
  "db.url": "spanner.googleapis.com",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  )
  expected_attributes.update(extra_attributes)

tests/unit/test_batch.py

@@ -17,6 +17,7 @@
 from unittest.mock import MagicMock
 from tests._helpers import (
  OpenTelemetryBase,
+ LIB_VERSION,
  StatusCode,
  enrich_with_otel_scope,
 )
@@ -33,6 +34,9 @@
  "db.url": "spanner.googleapis.com",
  "db.instance": "testing",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
 }
 enrich_with_otel_scope(BASE_ATTRIBUTES)
 

tests/unit/test_pool.py

@@ -22,6 +22,7 @@
 from google.cloud.spanner_v1._opentelemetry_tracing import trace_call
 from tests._helpers import (
  OpenTelemetryBase,
+ LIB_VERSION,
  StatusCode,
  enrich_with_otel_scope,
  HAS_OPENTELEMETRY_INSTALLED,
@@ -147,6 +148,9 @@ class TestFixedSizePool(OpenTelemetryBase):
  "db.url": "spanner.googleapis.com",
  "db.instance": "name",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  enrich_with_otel_scope(BASE_ATTRIBUTES)
 
@@ -483,6 +487,9 @@ class TestBurstyPool(OpenTelemetryBase):
  "db.url": "spanner.googleapis.com",
  "db.instance": "name",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  enrich_with_otel_scope(BASE_ATTRIBUTES)
 
@@ -721,6 +728,9 @@ class TestPingingPool(OpenTelemetryBase):
  "db.url": "spanner.googleapis.com",
  "db.instance": "name",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  enrich_with_otel_scope(BASE_ATTRIBUTES)
 

tests/unit/test_session.py

@@ -19,6 +19,7 @@
 import mock
 from tests._helpers import (
  OpenTelemetryBase,
+ LIB_VERSION,
  StatusCode,
  enrich_with_otel_scope,
 )
@@ -46,6 +47,9 @@ class TestSession(OpenTelemetryBase):
  "db.url": "spanner.googleapis.com",
  "db.instance": DATABASE_NAME,
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  enrich_with_otel_scope(BASE_ATTRIBUTES)
 

tests/unit/test_snapshot.py

@@ -19,6 +19,7 @@
 from google.cloud.spanner_v1 import RequestOptions, DirectedReadOptions
 from tests._helpers import (
  OpenTelemetryBase,
+ LIB_VERSION,
  StatusCode,
  HAS_OPENTELEMETRY_INSTALLED,
  enrich_with_otel_scope,
@@ -46,6 +47,9 @@
  "db.url": "spanner.googleapis.com",
  "db.instance": "testing",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
 }
 enrich_with_otel_scope(BASE_ATTRIBUTES)
 
@@ -533,14 +537,7 @@ def test_iteration_w_multiple_span_creation(self):
  self.assertEqual(span.name, name)
  self.assertEqual(
  dict(span.attributes),
- enrich_with_otel_scope(
- {
- "db.type": "spanner",
- "db.url": "spanner.googleapis.com",
- "db.instance": "testing",
- "net.host.name": "spanner.googleapis.com",
- }
- ),
+ enrich_with_otel_scope(BASE_ATTRIBUTES),
  )
 
 

tests/unit/test_transaction.py

@@ -23,6 +23,7 @@
 
 from tests._helpers import (
  HAS_OPENTELEMETRY_INSTALLED,
+ LIB_VERSION,
  OpenTelemetryBase,
  StatusCode,
  enrich_with_otel_scope,
@@ -62,6 +63,9 @@ class TestTransaction(OpenTelemetryBase):
  "db.url": "spanner.googleapis.com",
  "db.instance": "testing",
  "net.host.name": "spanner.googleapis.com",
+ "gcp.client.service": "spanner",
+ "gcp.client.version": LIB_VERSION,
+ "gcp.client.repo": "googleapis/python-spanner",
  }
  enrich_with_otel_scope(BASE_ATTRIBUTES)