Allow arbitrary metric prefixes (#315)

Author: mayurkale22

opencensus/stats/exporters/stackdriver_exporter.py

@@ -172,8 +172,10 @@ def make_request(self, view_data, limit):
         time_series = []
 
         resource = self.options.resource
+        metric_prefix = self.options.metric_prefix
         for v_data in view_data:
-            series = self.create_time_series_list(v_data, resource)
+            series = self.create_time_series_list(v_data, resource,
+                                                  metric_prefix)
             time_series.append(series)
 
             project_id = self.options.project_id
@@ -186,11 +188,12 @@ def make_request(self, view_data, limit):
                 time_series = []
         return requests
 
-    def create_time_series_list(self, v_data, resource_type):
+    def create_time_series_list(self, v_data, resource_type, metric_prefix):
         """ Create the TimeSeries object based on the view data
         """
         series = monitoring_v3.types.TimeSeries()
-        series.metric.type = namespaced_view_name(v_data.view.name)
+        series.metric.type = namespaced_view_name(v_data.view.name,
+                                                  metric_prefix)
 
         if resource_type == "":
             monitor_resource = MonitoredResourceUtil.get_instance()
@@ -268,7 +271,8 @@ def create_metric_descriptor(self, view):
         view_aggregation = view.aggregation
         view_name = view.name
 
-        metric_type = namespaced_view_name(view_name)
+        metric_type = namespaced_view_name(view_name,
+                                           self.options.metric_prefix)
         value_type = None
         unit = view_measure.unit
         metric_desc = monitoring_v3.enums.MetricDescriptor
@@ -357,10 +361,12 @@ def get_task_value():
     return task_value
 
 
-def namespaced_view_name(view_name):
+def namespaced_view_name(view_name, metric_prefix):
     """ create string to be used as metric type
     """
-    return os.path.join("custom.googleapis.com", "opencensus", view_name)
+    if metric_prefix == "":
+        return os.path.join("custom.googleapis.com", "opencensus", view_name)
+    return os.path.join(metric_prefix, view_name)
 
 
 def new_label_descriptors(defaults, keys):

tests/unit/stats/exporter/test_stackdriver_stats.py

@@ -160,8 +160,11 @@ def test_new_label_descriptors(self):
     def test_namespacedviews(self):
         view_name = "view-1"
         expected_view_name_namespaced = "custom.googleapis.com/opencensus/%s" % view_name
-        view_name_namespaced = stackdriver.namespaced_view_name(view_name)
+        view_name_namespaced = stackdriver.namespaced_view_name(view_name, "")
+        self.assertEqual(expected_view_name_namespaced, view_name_namespaced)
 
+        expected_view_name_namespaced = "kubernetes.io/myorg/%s" % view_name
+        view_name_namespaced = stackdriver.namespaced_view_name(view_name, "kubernetes.io/myorg")
         self.assertEqual(expected_view_name_namespaced, view_name_namespaced)
 
     def test_on_register_view(self):
@@ -293,11 +296,13 @@ def test_create_timeseries(self, monitor_resource_mock):
 
         v_data = measure_map.measure_to_view_map.get_view(VIDEO_SIZE_VIEW_NAME, None)
 
-        time_series = exporter.create_time_series_list(v_data, "")
+        time_series = exporter.create_time_series_list(v_data, "", "")
         self.assertEquals(time_series.resource.type, "global")
+        self.assertEquals(time_series.metric.type, "custom.googleapis.com/opencensus/my.org/views/video_size_test2")
         self.assertIsNotNone(time_series)
 
-        time_series = exporter.create_time_series_list(v_data, "global")
+        time_series = exporter.create_time_series_list(v_data, "global", "kubernetes.io/myorg")
+        self.assertEquals(time_series.metric.type, "kubernetes.io/myorg/my.org/views/video_size_test2")
         self.assertIsNotNone(time_series)
 
 
@@ -342,11 +347,13 @@ def test_create_timeseries_with_resource(self, monitor_resource_mock):
         monitor_resource_mock.return_value.resource_type = 'gce_instance'
         monitor_resource_mock.return_value.get_resource_labels.return_value = mocked_labels
 
-        time_series = exporter.create_time_series_list(v_data, "")
+        time_series = exporter.create_time_series_list(v_data, "", "")
         self.assertEquals(time_series.resource.type, "gce_instance")
+        self.assertEquals(time_series.metric.type, "custom.googleapis.com/opencensus/my.org/views/video_size_test2")
         self.assertIsNotNone(time_series)
 
-        time_series = exporter.create_time_series_list(v_data, "global")
+        time_series = exporter.create_time_series_list(v_data, "global", "")
+        self.assertEquals(time_series.metric.type, "custom.googleapis.com/opencensus/my.org/views/video_size_test2")
         self.assertIsNotNone(time_series)
 
     @mock.patch('opencensus.stats.exporters.stackdriver_exporter.'
@@ -389,7 +396,8 @@ def test_create_timeseries_str_tagvalue(self, monitor_resource_mock):
 
         v_data = measure_map.measure_to_view_map.get_view(view_name1, None)
 
-        time_series = exporter.create_time_series_list(v_data,"global")
+        time_series = exporter.create_time_series_list(v_data, "global", "kubernetes.io/myorg/")
+        self.assertEquals(time_series.metric.type, "kubernetes.io/myorg/view-name1")
         self.assertIsNotNone(time_series)
 
     @mock.patch('opencensus.stats.exporters.stackdriver_exporter.'
@@ -432,7 +440,8 @@ def test_create_timeseries_last_value_float_tagvalue(self, monitor_resource_mock
 
         v_data = measure_map.measure_to_view_map.get_view(view_name1, None)
 
-        time_series = exporter.create_time_series_list(v_data,"global")
+        time_series = exporter.create_time_series_list(v_data,"global", "kubernetes.io/myorg")
+        self.assertEquals(time_series.metric.type, "kubernetes.io/myorg/view-name1")
         self.assertIsNotNone(time_series)
 
     @mock.patch('opencensus.stats.exporters.stackdriver_exporter.'
@@ -475,7 +484,8 @@ def test_create_timeseries_float_tagvalue(self, monitor_resource_mock):
 
         v_data = measure_map.measure_to_view_map.get_view(view_name2, None)
 
-        time_series = exporter.create_time_series_list(v_data,"global")
+        time_series = exporter.create_time_series_list(v_data, "global", "")
+        self.assertEquals(time_series.metric.type, "custom.googleapis.com/opencensus/view-name2")
         self.assertIsNotNone(time_series)
 
     def test_create_metric_descriptor_count(self):