Merge branch 'stackhpc/victoria' into upstream/victoria-2022-09-26

Author: mnasiadka

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @stackhpc/openstack

.github/workflows/tag-and-release.yml

@@ -0,0 +1,11 @@
+---
+name: Tag & Release
+'on':
+  push:
+    branches:
+      - stackhpc/victoria
+permissions:
+  contents: write
+jobs:
+  tag-and-release:
+    uses: stackhpc/.github/.github/workflows/tag-and-release.yml@main

.github/workflows/tox.yml

@@ -0,0 +1,7 @@
+---
+name: Tox Continuous Integration
+'on':
+  pull_request:
+jobs:
+  tox:
+    uses: stackhpc/.github/.github/workflows/tox.yml@main

cloudkitty/api/v1/controllers/rating.py

@@ -17,6 +17,7 @@
 from oslo_log import log
 import pecan
 from pecan import rest
+
 from stevedore import extension
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan

cloudkitty/collector/__init__.py

@@ -90,10 +90,11 @@ def MetricDict(value):
     Required('metadata', default=list): [
         All(str, Length(min=1))
     ],
-    # Mutate collected value. May be any of (NONE, NUMBOOL, FLOOR, CEIL).
+    # Mutate collected value. May be any of:
+    # (NONE, NUMBOOL, NOTNUMBOOL, FLOOR, CEIL).
     # Defaults to NONE
     Required('mutate', default='NONE'):
-        In(['NONE', 'NUMBOOL', 'FLOOR', 'CEIL']),
+        In(['NONE', 'NUMBOOL', 'NOTNUMBOOL', 'FLOOR', 'CEIL']),
     # Collector-specific args. Should be overriden by schema provided for
     # the given collector
     Optional('extra_args'): dict,

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,6 +203,14 @@ def fetch_all(self, metric_name, start, end, scope_id, q_filter=None):
             ', '.join(groupby + metadata)
         )
 
+        # 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(
                 query,

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',
         }
 

cloudkitty/utils/__init__.py

@@ -259,6 +259,9 @@ def mutate(value, mode='NONE'):
     if mode == 'NUMBOOL':
         return float(value != 0.0)
 
+    if mode == 'NOTNUMBOOL':
+        return float(value == 0.0)
+
     if mode == 'FLOOR':
         return math.floor(value)
 

doc/source/admin/configuration/collector.rst

@@ -186,6 +186,9 @@ Four values are accepted for this parameter:
 
 * ``NUMBOOL``: If the collected qty equals 0, leave it at 0. Else, set it to 1.
 
+* ``NOTNUMBOOL``: If the collected qty equals 0, set it to 1. Else, set it to
+  0.
+
 .. warning::
 
    Quantity mutation is done **after** conversion. Example::
@@ -214,6 +217,21 @@ then defined based on the instance metadata. Example:
        metadata:
          - flavor_id
 
+The ``NOTNUMBOOL`` mutator is useful for status-like metrics where 0 denotes
+the billable state. For example the following Prometheus metric has value of 0
+when the instance is in ACTIVE state but 4 if the instance is in ERROR state:
+
+.. code-block:: yaml
+
+   metrics:
+     openstack_nova_server_status:
+       unit: instance
+       mutate: NOTNUMBOOL
+       groupby:
+         - id
+       metadata:
+         - flavor_id
+
 Display name
 ~~~~~~~~~~~~
 
@@ -311,6 +329,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/notnumbool-mutator-ab056e86f2bc843d.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    The new "NOTNUMBOOL" mutator has been added. This mutator is, essentially,
+    an opposite of the "NUMBOOL" mutator as it returns 1.0 when quantity is 0
+    and 0.0 otherwise.