Merge pull request #20 from yaacov/add-hawkular-old-api-option

Add option to use data restful endpoint

Author: burmanm

hawkular/metrics.py

@@ -67,6 +67,9 @@ class HawkularMetricsError(HTTPError):
 class HawkularMetricsConnectionError(URLError):
     pass
 
+class HawkularMetricsStatusError(ValueError):
+    pass
+
 class HawkularHTTPErrorProcessor(HTTPErrorProcessor):
     """
     Hawkular-Metrics uses http codes 201, 204
@@ -94,7 +97,8 @@ def __init__(self,
                  context=None,
                  token=None,
                  username=None,
-                 password=None):
+                 password=None,
+                 auto_set_legacy_api=True):
         """
         A new instance of HawkularMetricsClient is created with the following defaults:
 
@@ -118,10 +122,17 @@ def __init__(self,
         self.token = token
         self.username = username
         self.password = password
+        self.legacy_api = False
 
         opener = build_opener(HawkularHTTPErrorProcessor())
         install_opener(opener)
 
+        # Call the server status endpoint to get the version number,
+        # Use the return sematic version to set the value of legacy_api
+        if auto_set_legacy_api:
+            major, minor, patch = self.query_semantic_version()
+            self.legacy_api = (major == 0 and minor < 16)
+
     """
     Internal methods
     """
@@ -142,17 +153,20 @@ def _get_metrics_single_url(self, metric_type, metric_id):
         return self._get_url(metric_type) + '/{0}'.format(self._clean_metric_id(metric_id))
 
     def _get_metrics_raw_url(self, metrics_url):
-        return metrics_url + '/raw'
+        return metrics_url + '/data' if self.legacy_api else metrics_url + '/raw'
 
     def _get_metrics_stats_url(self, metrics_url):
-        return metrics_url + '/stats'
+        return metrics_url + '/data' if self.legacy_api else metrics_url + '/stats'
 
     def _get_metrics_tags_url(self, metrics_url):
         return metrics_url + '/tags'
 
     def _get_tenants_url(self):
         return self._get_base_url() + 'tenants'
 
+    def _get_status_url(self):
+        return self._get_base_url() + 'status'
+
     @staticmethod
     def _transform_tags(**tags):
         return ','.join("%s:%s" % (key,val) for (key,val) in tags.items())
@@ -236,6 +250,16 @@ def _handle_error(self, e):
             e.__class__ = HawkularMetricsConnectionError
             e.msg = "Error, could not send event(s) to the Hawkular Metrics: " + str(e.reason)
             raise e
+        elif isinstance(e, KeyError):
+            # Cast to HawkularMetricsStatusError
+            e.__class__ = HawkularMetricsStatusError
+            e.msg = "Error, unable to get implementation version for metrics: " + str(e.reason)
+            raise e
+        elif isinstance(e, ValueError):
+            # Cast to HawkularMetricsStatusError
+            e.__class__ = HawkularMetricsStatusError
+            e.msg = "Error, unable to determine implementation version for metrics: " + str(e.reason)
+            raise e
         else:
             raise e
 
@@ -399,6 +423,22 @@ def create_tenant(self, tenant_id, retentions=None):
 
         self._post(self._get_tenants_url(), json.dumps(item, indent=2))
 
+    """
+    General information related queries
+    """
+
+    def query_semantic_version(self):
+        status_hash = self.query_status()
+        try:
+            version = status_hash['Implementation-Version']
+            major, minor, patch = map(int, version.split('.')[:3])
+        except Exception as e:
+            self._handle_error(e)
+        return major, minor, patch
+
+    def query_status(self):
+        return self._get(self._get_status_url())
+
 """
 Static methods
 """

hawkular/metrics_test.py

@@ -177,7 +177,7 @@ def test_add_availability_single(self):
     def test_add_string_single(self):
         self.client.push(MetricType.String, 'test.string.1', "foo")
         data = self.client.query_metric(MetricType.String, 'test.string.1')
-        self.assertEqual(data, 'foo')
+        self.assertEqual(data[0]["value"], 'foo')
 
     def test_add_gauge_multi_datapoint(self):
         metric_1v = create_datapoint(float(1.45))
@@ -251,6 +251,32 @@ def test_tenant_changing(self):
         m = self.client.query_metric_definitions(MetricType.Availability)
         self.assertEqual(0, len(m))
 
-        
+    def test_query_semantic_version(self):
+        major, minor, patch = self.client.query_semantic_version()
+        self.assertTrue(0 <= major <= 1000)
+        self.assertTrue(0 <= minor <= 1000)
+
+    def test_query_status(self):
+        status = self.client.query_status()
+        self.assertTrue('Implementation-Version' in status)
+
+    def test_get_metrics_raw_url(self):
+        self.client.legacy_api = True
+        url = self.client._get_metrics_raw_url('some.key')
+        self.assertEqual('some.key/data', url)
+
+        self.client.legacy_api = False
+        url = self.client._get_metrics_raw_url('some.key')
+        self.assertEqual('some.key/raw', url)
+
+    def test_get_metrics_stats_url(self):
+        self.client.legacy_api = True
+        url = self.client._get_metrics_stats_url('some.key')
+        self.assertEqual('some.key/data', url)
+
+        self.client.legacy_api = False
+        url = self.client._get_metrics_stats_url('some.key')
+        self.assertEqual('some.key/stats', url)
+
 if __name__ == '__main__':
     unittest.main()