upgrade opencensus-ext-stackdriver to use google-cloud-monitoring v2 library (#1060)

aabmass · web-flow · commit 15b126ac5a83 · 2021-08-11T00:05:16.000-04:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -39,6 +39,6 @@ jobs:
         with:
           path: .tox
           # bump version prefix to fully reset caches
-          key: v1-tox-${{ matrix.python-version }}-${{ hashFiles('tox.ini') }}
+          key: v1-tox-${{ matrix.python-version }}-${{ hashFiles('tox.ini', '**/setup.py') }}
       - name: run tox
         run: tox -f ${{ matrix.python-version }}
diff --git a/contrib/opencensus-ext-stackdriver/opencensus/ext/stackdriver/stats_exporter/__init__.py b/contrib/opencensus-ext-stackdriver/opencensus/ext/stackdriver/stats_exporter/__init__.py
@@ -21,8 +21,10 @@
 from datetime import datetime
 
 import google.auth
+from google.api import metric_pb2
 from google.api_core.gapic_v1 import client_info
 from google.cloud import monitoring_v3
+from google.protobuf import timestamp_pb2
 
 from opencensus.common import utils
 from opencensus.common.monitored_resource import (
@@ -51,20 +53,20 @@
 # OC metric descriptor type to SD metric kind and value type
 OC_MD_TO_SD_TYPE = {
     metric_descriptor.MetricDescriptorType.CUMULATIVE_INT64:
-    (monitoring_v3.enums.MetricDescriptor.MetricKind.CUMULATIVE,
-     monitoring_v3.enums.MetricDescriptor.ValueType.INT64),
+    (metric_pb2.MetricDescriptor.MetricKind.CUMULATIVE,
+     metric_pb2.MetricDescriptor.ValueType.INT64),
     metric_descriptor.MetricDescriptorType.CUMULATIVE_DOUBLE:
-    (monitoring_v3.enums.MetricDescriptor.MetricKind.CUMULATIVE,
-     monitoring_v3.enums.MetricDescriptor.ValueType.DOUBLE),
+    (metric_pb2.MetricDescriptor.MetricKind.CUMULATIVE,
+     metric_pb2.MetricDescriptor.ValueType.DOUBLE),
     metric_descriptor.MetricDescriptorType.CUMULATIVE_DISTRIBUTION:
-    (monitoring_v3.enums.MetricDescriptor.MetricKind.CUMULATIVE,
-     monitoring_v3.enums.MetricDescriptor.ValueType.DISTRIBUTION),
+    (metric_pb2.MetricDescriptor.MetricKind.CUMULATIVE,
+     metric_pb2.MetricDescriptor.ValueType.DISTRIBUTION),
     metric_descriptor.MetricDescriptorType.GAUGE_INT64:
-    (monitoring_v3.enums.MetricDescriptor.MetricKind.GAUGE,
-     monitoring_v3.enums.MetricDescriptor.ValueType.INT64),
+    (metric_pb2.MetricDescriptor.MetricKind.GAUGE,
+     metric_pb2.MetricDescriptor.ValueType.INT64),
     metric_descriptor.MetricDescriptorType.GAUGE_DOUBLE:
-    (monitoring_v3.enums.MetricDescriptor.MetricKind.GAUGE,
-     monitoring_v3.enums.MetricDescriptor.ValueType.DOUBLE)
+    (metric_pb2.MetricDescriptor.MetricKind.GAUGE,
+     metric_pb2.MetricDescriptor.ValueType.DOUBLE)
 }
 
 
@@ -158,7 +160,9 @@ def export_metrics(self, metrics):
         ts_batches = self.create_batched_time_series(metrics)
         for ts_batch in ts_batches:
             self.client.create_time_series(
-                self.client.project_path(self.options.project_id), ts_batch)
+                name=self.client.common_project_path(self.options.project_id),
+                time_series=ts_batch,
+            )
 
     def create_batched_time_series(self, metrics,
                                    batch_size=MAX_TIME_SERIES_PER_UPLOAD):
@@ -173,7 +177,7 @@ def create_time_series_list(self, metric):
 
     def _convert_series(self, metric, ts):
         """Convert an OC timeseries to a SD series."""
-        series = monitoring_v3.types.TimeSeries()
+        series = monitoring_v3.TimeSeries()
         series.metric.type = self.get_metric_type(metric.descriptor)
 
         for lk, lv in self.options.default_monitoring_labels.items():
@@ -187,9 +191,10 @@ def _convert_series(self, metric, ts):
         set_monitored_resource(series, self.options.resource)
 
         for point in ts.points:
-            sd_point = series.points.add()
+            sd_point = monitoring_v3.Point()
             # this just modifies points, no return
             self._convert_point(metric, ts, point, sd_point)
+            series.points.append(sd_point)
         return series
 
     def _convert_point(self, metric, ts, point, sd_point):
@@ -245,14 +250,17 @@ def _convert_point(self, metric, ts, point, sd_point):
         timestamp_start = (start - EPOCH_DATETIME).total_seconds()
         timestamp_end = (end - EPOCH_DATETIME).total_seconds()
 
-        sd_point.interval.end_time.seconds = int(timestamp_end)
-
-        secs = sd_point.interval.end_time.seconds
-        sd_point.interval.end_time.nanos = int((timestamp_end - secs) * 1e9)
+        end_time_pb = timestamp_pb2.Timestamp()
+        end_time_pb.seconds = int(timestamp_end)
+        end_time_pb.nanos = int((timestamp_end - end_time_pb.seconds) * 1e9)
+        sd_point.interval.end_time = end_time_pb
 
-        start_time = sd_point.interval.start_time
-        start_time.seconds = int(timestamp_start)
-        start_time.nanos = int((timestamp_start - start_time.seconds) * 1e9)
+        start_time_pb = timestamp_pb2.Timestamp()
+        start_time_pb.seconds = int(timestamp_start)
+        start_time_pb.nanos = int(
+            (timestamp_start - start_time_pb.seconds) * 1e9,
+        )
+        sd_point.interval.start_time = start_time_pb
 
     def get_metric_type(self, oc_md):
         """Get a SD metric type for an OC metric descriptor."""
@@ -273,7 +281,7 @@ def get_metric_descriptor(self, oc_md):
         desc_labels = new_label_descriptors(
             self.options.default_monitoring_labels, oc_md.label_keys)
 
-        descriptor = monitoring_v3.types.MetricDescriptor(labels=desc_labels)
+        descriptor = metric_pb2.MetricDescriptor(labels=desc_labels)
         metric_type = self.get_metric_type(oc_md)
         descriptor.type = metric_type
         descriptor.metric_kind = metric_kind
@@ -295,8 +303,10 @@ def register_metric_descriptor(self, oc_md):
                 return self._md_cache[metric_type]
 
         descriptor = self.get_metric_descriptor(oc_md)
-        project_name = self.client.project_path(self.options.project_id)
-        sd_md = self.client.create_metric_descriptor(project_name, descriptor)
+        project_name = self.client.common_project_path(self.options.project_id)
+        sd_md = self.client.create_metric_descriptor(
+            name=project_name, metric_descriptor=descriptor
+        )
         with self._md_lock:
             self._md_cache[metric_type] = sd_md
         return sd_md
diff --git a/contrib/opencensus-ext-stackdriver/setup.py b/contrib/opencensus-ext-stackdriver/setup.py
@@ -37,7 +37,7 @@
     include_package_data=True,
     long_description=open('README.rst').read(),
     install_requires=[
-        'google-cloud-monitoring >= 0.30.0, < 1.0.0',
+        'google-cloud-monitoring ~= 2.0',
         'google-cloud-trace >= 0.20.0, < 1.0.0',
         'rsa <= 4.0; python_version<="3.4"',
         'opencensus >= 0.8.dev0, < 1.0.0',
diff --git a/contrib/opencensus-ext-stackdriver/tests/test_stackdriver_stats.py b/contrib/opencensus-ext-stackdriver/tests/test_stackdriver_stats.py
@@ -13,10 +13,11 @@
 # limitations under the License.
 
 import unittest
-from datetime import datetime
+from datetime import datetime, timedelta
 
 import google.auth
 import mock
+from google.api import metric_pb2
 from google.cloud import monitoring_v3
 
 from opencensus.common import utils
@@ -433,12 +434,12 @@ def test_get_metric_descriptor(self):
         sd_md = exporter.get_metric_descriptor(oc_md)
         self.assertEqual(
             sd_md.metric_kind,
-            monitoring_v3.enums.MetricDescriptor.MetricKind.GAUGE)
+            metric_pb2.MetricDescriptor.MetricKind.GAUGE)
         self.assertEqual(
             sd_md.value_type,
-            monitoring_v3.enums.MetricDescriptor.ValueType.INT64)
+            metric_pb2.MetricDescriptor.ValueType.INT64)
 
-        self.assertIsInstance(sd_md, monitoring_v3.types.MetricDescriptor)
+        self.assertIsInstance(sd_md, metric_pb2.MetricDescriptor)
         exporter.client.create_metric_descriptor.assert_not_called()
 
     def test_get_metric_descriptor_bad_type(self):
@@ -530,9 +531,13 @@ def test_export_metrics(self):
         exporter.export_metrics([mm])
 
         self.assertEqual(exporter.client.create_time_series.call_count, 1)
-        sd_args = exporter.client.create_time_series.call_args[0][1]
+        sd_args = exporter.client.create_time_series.call_args.kwargs[
+            'time_series'
+        ]
         self.assertEqual(len(sd_args), 1)
-        [sd_arg] = exporter.client.create_time_series.call_args[0][1]
+        [sd_arg] = exporter.client.create_time_series.call_args.kwargs[
+            'time_series'
+        ]
         self.assertEqual(sd_arg.points[0].value.int64_value, 123)
 
 
@@ -654,21 +659,25 @@ def test_export_single_metric(self, mock_stats, mock_client):
             exporter.client.create_metric_descriptor.call_count,
             1)
         md_call_arg =\
-            exporter.client.create_metric_descriptor.call_args[0][1]
+            exporter.client.create_metric_descriptor.call_args.kwargs[
+                'metric_descriptor'
+            ]
         self.assertEqual(
             md_call_arg.metric_kind,
-            monitoring_v3.enums.MetricDescriptor.MetricKind.GAUGE
+            metric_pb2.MetricDescriptor.MetricKind.GAUGE
         )
         self.assertEqual(
             md_call_arg.value_type,
-            monitoring_v3.enums.MetricDescriptor.ValueType.INT64
+            metric_pb2.MetricDescriptor.ValueType.INT64
         )
 
         exporter.client.create_time_series.assert_called()
         self.assertEqual(
             exporter.client.create_time_series.call_count,
             1)
-        ts_call_arg = exporter.client.create_time_series.call_args[0][1]
+        ts_call_arg = exporter.client.create_time_series.call_args.kwargs[
+            'time_series'
+        ]
         self.assertEqual(len(ts_call_arg), 1)
         self.assertEqual(len(ts_call_arg[0].points), 1)
         self.assertEqual(ts_call_arg[0].points[0].value.int64_value, 123)
@@ -812,6 +821,9 @@ def test_create_timeseries(self, monitor_resource_mock):
         v_data = measure_map.measure_to_view_map.get_view(
             VIDEO_SIZE_VIEW_NAME, None)
 
+        v_data._start_time = (
+            TEST_TIME - timedelta(minutes=1)
+        ).strftime(stackdriver.EPOCH_PATTERN)
         v_data = metric_utils.view_data_to_metric(v_data, TEST_TIME)
 
         time_series_list = exporter.create_time_series_list(v_data)
@@ -840,6 +852,15 @@ def test_create_timeseries(self, monitor_resource_mock):
         )
         self.assertEqual(value.distribution_value, expected_distb)
 
+        start_time_pb = (
+            time_series.points[0].interval.start_time.timestamp_pb()
+        )
+        end_time_pb = time_series.points[0].interval.end_time.timestamp_pb()
+        self.assertEqual(start_time_pb.seconds, 1545699663)
+        self.assertEqual(start_time_pb.nanos, 4053)
+        self.assertEqual(end_time_pb.seconds, 1545699723)
+        self.assertEqual(end_time_pb.nanos, 4053)
+
     @mock.patch('opencensus.ext.stackdriver.stats_exporter.'
                 'monitored_resource.get_instance')
     def test_create_timeseries_with_resource(self, monitor_resource_mock):
@@ -1024,7 +1045,7 @@ def test_create_timeseries_str_tagvalue(self, monitor_resource_mock):
         self.assertIsNotNone(time_series.resource)
 
         self.assertEqual(len(time_series.points), 1)
-        expected_value = monitoring_v3.types.TypedValue()
+        expected_value = monitoring_v3.TypedValue()
         # TODO: #565
         expected_value.double_value = 25.0 * MiB
         self.assertEqual(time_series.points[0].value, expected_value)
@@ -1066,7 +1087,7 @@ def test_create_timeseries_str_tagvalue_count_aggregtation(
         self.assertIsNotNone(time_series.resource)
 
         self.assertEqual(len(time_series.points), 1)
-        expected_value = monitoring_v3.types.TypedValue()
+        expected_value = monitoring_v3.TypedValue()
         expected_value.int64_value = 3
         self.assertEqual(time_series.points[0].value, expected_value)
 
@@ -1107,7 +1128,7 @@ def test_create_timeseries_last_value_float_tagvalue(
         self.assertIsNotNone(time_series.resource)
 
         self.assertEqual(len(time_series.points), 1)
-        expected_value = monitoring_v3.types.TypedValue()
+        expected_value = monitoring_v3.TypedValue()
         expected_value.double_value = 25.7 * MiB
         self.assertEqual(time_series.points[0].value, expected_value)
 
@@ -1163,7 +1184,7 @@ def test_create_timeseries_float_tagvalue(self, monitor_resource_mock):
         self.assertIsNotNone(time_series.resource)
 
         self.assertEqual(len(time_series.points), 1)
-        expected_value = monitoring_v3.types.TypedValue()
+        expected_value = monitoring_v3.TypedValue()
         expected_value.double_value = 2.2 + 25 * MiB
         self.assertEqual(time_series.points[0].value, expected_value)
 
@@ -1290,7 +1311,7 @@ def test_create_timeseries_disjoint_tags(self, monitoring_resoure_mock):
         self.assertIsNotNone(time_series.resource)
 
         self.assertEqual(len(time_series.points), 1)
-        expected_value = monitoring_v3.types.TypedValue()
+        expected_value = monitoring_v3.TypedValue()
         # TODO: #565
         expected_value.double_value = 25.0 * MiB
         self.assertEqual(time_series.points[0].value, expected_value)
diff --git a/tests/system/stats/stackdriver/stackdriver_stats_test.py b/tests/system/stats/stackdriver/stackdriver_stats_test.py
@@ -46,7 +46,7 @@ class TestBasicStats(unittest.TestCase):
 
     def check_sd_md(self, exporter, view_description):
         """Check that the metric descriptor was written to stackdriver."""
-        name = exporter.client.project_path(PROJECT)
+        name = exporter.client.common_project_path(PROJECT)
         list_metrics_descriptors = exporter.client.list_metric_descriptors(
             name)
 
