Merge pull request #2 from stackhpc/feature/wallaby/custom-query-suffix

Support appending custom query suffix

Author: priteau

cloudkitty/collector/prometheus.py

@@ -18,6 +18,7 @@
 
 from oslo_config import cfg
 from oslo_log import log
+from voluptuous import All
 from voluptuous import In
 from voluptuous import Optional
 from voluptuous import Required
@@ -83,7 +84,9 @@
                 'changes', 'delta', 'deriv',
                 'idelta', 'irange', 'irate',
                 'rate'
-            ])
+            ]),
+        Optional('query_prefix', default=''): All(str),
+        Optional('query_suffix', default=''): All(str),
     }
 }
 
@@ -159,6 +162,8 @@ def fetch_all(self, metric_name, start, end, scope_id, q_filter=None):
             'range_function')
         groupby = self.conf[metric_name].get('groupby', [])
         metadata = self.conf[metric_name].get('metadata', [])
+        query_prefix = self.conf[metric_name]['extra_args']['query_prefix']
+        query_suffix = self.conf[metric_name]['extra_args']['query_suffix']
         period = tzutils.diff_seconds(end, start)
         time = end
 
@@ -198,7 +203,13 @@ def fetch_all(self, metric_name, start, end, scope_id, q_filter=None):
             ', '.join(groupby + metadata)
         )
 
-        LOG.debug("Calling Prometheus with query: %s", query)
+        # Add custom query prefix
+        if query_prefix:
+            query = "{0} {1}".format(query_prefix, query)
+
+        # Add custom query suffix
+        if query_suffix:
+            query = "{0} {1}".format(query, query_suffix)
 
         try:
             res = self._conn.get_instant(

cloudkitty/tests/collectors/test_validation.py

@@ -131,6 +131,8 @@ def test_prometheus_minimal_config_empty_extra_args(self):
         expected_output['metric_one']['groupby'].append('project_id')
         expected_output['metric_one']['extra_args'] = {
             'aggregation_method': 'max',
+            'query_prefix': '',
+            'query_suffix': '',
         }
         self.assertEqual(
             collector.prometheus.PrometheusCollector.check_configuration(data),
@@ -143,6 +145,8 @@ def test_prometheus_minimal_config_no_extra_args(self):
         expected_output['metric_one']['groupby'].append('project_id')
         expected_output['metric_one']['extra_args'] = {
             'aggregation_method': 'max',
+            'query_prefix': '',
+            'query_suffix': '',
         }
         self.assertEqual(
             collector.prometheus.PrometheusCollector.check_configuration(data),
@@ -154,13 +158,17 @@ def test_prometheus_minimal_config_minimal_extra_args(self):
         data['metrics']['metric_one']['extra_args'] = {
             'aggregation_method': 'max',
             'query_function': 'abs',
+            'query_prefix': 'custom_prefix',
+            'query_suffix': 'custom_suffix',
             'range_function': 'delta',
         }
         expected_output = copy.deepcopy(self.base_output)
         expected_output['metric_one']['groupby'].append('project_id')
         expected_output['metric_one']['extra_args'] = {
             'aggregation_method': 'max',
             'query_function': 'abs',
+            'query_prefix': 'custom_prefix',
+            'query_suffix': 'custom_suffix',
             'range_function': 'delta',
         }
 

doc/source/admin/configuration/collector.rst

@@ -340,6 +340,12 @@ Prometheus
   ``log10``, ``round``, ``sqrt``. For more information on these functions,
   you can check `this page`_
 
+* ``query_prefix``: Optional argument. An arbitrary prefix to add to the
+  Prometheus query generated by CloudKitty, separated by a space.
+
+* ``query_suffix``: Optional argument. An arbitrary suffix to add to the
+  Prometheus query generated by CloudKitty, separated by a space.
+
 * ``range_function``: Optional argument. The function to apply instead of the
   implicit ``{aggregation_method}_over_time``. Must be one of ``changes``,
   ``delta``, ``deriv``, ``idelta``, ``irange``, ``irate``, ``rate``. For more

releasenotes/notes/prometheus-custom-query-ab2dc00e97b14be2.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Adds support for specifying optional prefix and/or suffix to add to
+    Prometheus queries.