Added Attempt failure test

lszinv · lszinv · commit 2dd3a0e8418e · 2025-01-29T19:38:57.000-08:00
diff --git a/google/cloud/spanner_v1/client.py b/google/cloud/spanner_v1/client.py
@@ -48,7 +48,10 @@
 from google.cloud.spanner_v1._helpers import _merge_query_options
 from google.cloud.spanner_v1._helpers import _metadata_with_prefix
 from google.cloud.spanner_v1.instance import Instance
-from google.cloud.spanner_v1.metrics.constants import ENABLE_SPANNER_METRICS_ENV_VAR
+from google.cloud.spanner_v1.metrics.constants import (
+    ENABLE_SPANNER_METRICS_ENV_VAR,
+    METRIC_EXPORT_INTERVAL_MS,
+)
 from google.cloud.spanner_v1.metrics.spanner_metrics_tracer_factory import (
     SpannerMetricsTracerFactory,
 )
@@ -227,7 +230,10 @@ def __init__(
             if not _get_spanner_emulator_host():
                 meter_provider = MeterProvider(
                     metric_readers=[
-                        PeriodicExportingMetricReader(CloudMonitoringMetricsExporter())
+                        PeriodicExportingMetricReader(
+                            CloudMonitoringMetricsExporter(),
+                            export_interval_millis=METRIC_EXPORT_INTERVAL_MS,
+                        )
                     ]
                 )
             metrics.set_meter_provider(meter_provider)
diff --git a/google/cloud/spanner_v1/metrics/constants.py b/google/cloud/spanner_v1/metrics/constants.py
@@ -1,4 +1,3 @@
-﻿# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -68,3 +67,5 @@
     METRIC_NAME_OPERATION_COUNT,
     METRIC_NAME_ATTEMPT_COUNT,
 ]
+
+METRIC_EXPORT_INTERVAL_MS = 60000  # 1 Minute
diff --git a/google/cloud/spanner_v1/metrics/metrics_capture.py b/google/cloud/spanner_v1/metrics/metrics_capture.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -41,7 +40,6 @@ def __enter__(self):
             MetricsCapture: The instance of the context manager.
         """
         factory = SpannerMetricsTracerFactory()
-
         # Define a new metrics tracer for the new operation
         SpannerMetricsTracerFactory.current_metrics_tracer = (
             factory.create_metrics_tracer()
diff --git a/google/cloud/spanner_v1/metrics/metrics_exporter.py b/google/cloud/spanner_v1/metrics/metrics_exporter.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -351,7 +350,6 @@ def export(
         if not HAS_OPENTELEMETRY_INSTALLED:
             logger.warning("Metric exporter called without dependencies installed.")
             return False
-
         time_series_list = self._resource_metrics_to_timeseries_pb(metrics_data)
         self._batch_write(time_series_list, timeout_millis)
         return True
diff --git a/google/cloud/spanner_v1/metrics/metrics_interceptor.py b/google/cloud/spanner_v1/metrics/metrics_interceptor.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -138,8 +137,8 @@ def intercept(self, invoked_method, request_or_iterator, call_details):
         method_name = self._remove_prefix(
             call_details.method, SPANNER_METHOD_PREFIX
         ).replace("/", ".")
-        SpannerMetricsTracerFactory.current_metrics_tracer.set_method(method_name)
 
+        SpannerMetricsTracerFactory.current_metrics_tracer.set_method(method_name)
         SpannerMetricsTracerFactory.current_metrics_tracer.record_attempt_start()
         response = invoked_method(request_or_iterator, call_details)
         SpannerMetricsTracerFactory.current_metrics_tracer.record_attempt_completion()
@@ -150,5 +149,4 @@ def intercept(self, invoked_method, request_or_iterator, call_details):
             SpannerMetricsTracerFactory.current_metrics_trace.record_gfe_metrics(
                 metadata
             )
-
         return response
diff --git a/google/cloud/spanner_v1/metrics/metrics_tracer.py b/google/cloud/spanner_v1/metrics/metrics_tracer.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/google/cloud/spanner_v1/metrics/metrics_tracer_factory.py b/google/cloud/spanner_v1/metrics/metrics_tracer_factory.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/google/cloud/spanner_v1/metrics/spanner_metrics_tracer_factory.py b/google/cloud/spanner_v1/metrics/spanner_metrics_tracer_factory.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -36,7 +35,10 @@
 
     # Override Resource detector logging to not warn when GCP resources are not detected
     import logging
-    logging.getLogger("opentelemetry.resourcedetector.gcp_resource_detector").setLevel(logging.ERROR)
+
+    logging.getLogger("opentelemetry.resourcedetector.gcp_resource_detector").setLevel(
+        logging.ERROR
+    )
 
     HAS_OPENTELEMETRY_INSTALLED = True
 except ImportError:  # pragma: NO COVER
diff --git a/google/cloud/spanner_v1/services/spanner/transports/grpc.py b/google/cloud/spanner_v1/services/spanner/transports/grpc.py
@@ -124,6 +124,7 @@ def __init__(
         self._grpc_channel = None
         self._ssl_channel_credentials = ssl_channel_credentials
         self._stubs: Dict[str, Callable] = {}
+        self._metrics_interceptor = None
 
         if api_mtls_endpoint:
             warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning)
@@ -192,6 +193,7 @@ def __init__(
 
         # Wrap the gRPC channel with the metric interceptor
         if metrics_interceptor is not None:
+            self._metrics_interceptor = metrics_interceptor
             self._grpc_channel = grpc.intercept_channel(
                 self._grpc_channel, metrics_interceptor
             )
diff --git a/setup.py b/setup.py
@@ -52,7 +52,7 @@
         "opentelemetry-semantic-conventions >= 0.43b0",
         "opentelemetry-resourcedetector-gcp >= 1.8.0a0",
         "google-cloud-monitoring >= 2.16.0",
-        "mmh3 >= 5.0.1 ",
+        "mmh3 >= 4.1.0 ",
     ],
     "libcst": "libcst >= 0.2.5",
 }
diff --git a/tests/unit/test_metrics.py b/tests/unit/test_metrics.py
@@ -0,0 +1,65 @@
+﻿# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from unittest.mock import MagicMock
+from google.api_core.exceptions import ServiceUnavailable
+from google.cloud.spanner_v1.client import Client
+from unittest.mock import patch
+from grpc._interceptor import _UnaryOutcome
+from google.cloud.spanner_v1.metrics.spanner_metrics_tracer_factory import (
+    SpannerMetricsTracerFactory,
+)
+
+
+def test_metrics_emission_with_failure_attempt(monkeypatch):
+    monkeypatch.setenv("SPANNER_ENABLE_BUILTIN_METRICS", "true")
+    client = Client()
+    instance = client.instance("test-instance")
+    database = instance.database("example-db")
+
+    transport = database.spanner_api._transport
+    metrics_interceptor = transport._metrics_interceptor
+    original_intercept = metrics_interceptor.intercept
+    first_attempt = True
+
+    def mocked_raise(*args, **kwargs):
+        raise ServiceUnavailable("Service Unavailable")
+
+    def mocked_call(*args, **kwargs):
+        return _UnaryOutcome(MagicMock(), MagicMock())
+
+    def intercept_wrapper(invoked_method, request_or_iterator, call_details):
+        nonlocal original_intercept
+        nonlocal first_attempt
+        invoked_method = mocked_call
+        if first_attempt:
+            first_attempt = False
+            invoked_method = mocked_raise
+        response = original_intercept(
+            invoked_method=invoked_method,
+            request_or_iterator=request_or_iterator,
+            call_details=call_details,
+        )
+        return response
+
+    metrics_interceptor.intercept = intercept_wrapper
+    patch_path = "google.cloud.spanner_v1.metrics.metrics_exporter.CloudMonitoringMetricsExporter.export"
+    with patch(patch_path):
+        with database.snapshot():
+            pass
+
+    # Verify that the attempt count increased from the failed initial attempt
+    assert (
+        SpannerMetricsTracerFactory.current_metrics_tracer.current_op.attempt_count
+    ) == 2
diff --git a/tests/unit/test_metrics_capture.py b/tests/unit/test_metrics_capture.py
@@ -1,3 +1,17 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import pytest
 from unittest import mock
 from google.cloud.spanner_v1.metrics.metrics_capture import MetricsCapture
diff --git a/tests/unit/test_metrics_interceptor.py b/tests/unit/test_metrics_interceptor.py
@@ -1,3 +1,17 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import pytest
 from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
 from google.cloud.spanner_v1.metrics.spanner_metrics_tracer_factory import (
diff --git a/tests/unit/test_metrics_tracer.py b/tests/unit/test_metrics_tracer.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/tests/unit/test_metrics_tracer_factory.py b/tests/unit/test_metrics_tracer_factory.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2025 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# -- coding: utf-8 --`
`2`	`1`	`# Copyright 2025 Google LLC`
`3`	`2`	`#`
`4`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`@@ -68,3 +67,5 @@`
`68`	`67`	`METRIC_NAME_OPERATION_COUNT,`
`69`	`68`	`METRIC_NAME_ATTEMPT_COUNT,`
`70`	`69`	`]`
	`70`	`+`
	`71`	`+METRIC_EXPORT_INTERVAL_MS = 60000 # 1 Minute`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@`
`52`	`52`	`"opentelemetry-semantic-conventions >= 0.43b0",`
`53`	`53`	`"opentelemetry-resourcedetector-gcp >= 1.8.0a0",`
`54`	`54`	`"google-cloud-monitoring >= 2.16.0",`
`55`		`- "mmh3 >= 5.0.1 ",`
	`55`	`+ "mmh3 >= 4.1.0 ",`
`56`	`56`	`],`
`57`	`57`	`"libcst": "libcst >= 0.2.5",`
`58`	`58`	`}`