Add server_group label to prometheus exporter

This is adding a similar functionality which was introduced
in https://review.opendev.org/c/openstack/ceilometer/+/926176

Change-Id: Ic06841f3f73736d7124d6fa1e6668613ba9ce309

ceilometer/polling/prom_exporter.py

@@ -120,24 +120,45 @@ def _gen_labels(sample):
 
     if (sample.get('resource_metadata', '') != '' and
             sample.get('resource_metadata') is not None):
+        resource_metadata = sample['resource_metadata']
 
-        if (sample['resource_metadata'].get('host', '') != ''):
+        if (resource_metadata.get('host', '') != ''):
             labels['keys'].append("vm_instance")
-            labels['values'].append(sample['resource_metadata']['host'])
+            labels['values'].append(resource_metadata['host'])
             index += 1
 
-        if (sample['resource_metadata'].get('display_name', '') != ''):
+        if (resource_metadata.get('display_name', '') != ''):
             labels['keys'].append("resource_name")
-            labels['values'].append(sample['resource_metadata']
+            labels['values'].append(resource_metadata['display_name'])
-                                    ['display_name'])
 
-        if (sample['resource_metadata'].get('name', '') != ''):
+        if (resource_metadata.get('name', '') != ''):
             labels['keys'].append("resource_name")
             if (labels['values'][index] if index < len(labels['values'])
                     else '' != ''):
                 labels['values'].append(labels['values'][index] + ":" +
-                                        sample['resource_metadata']['name'])
+                                        resource_metadata['name'])
             else:
-                labels['values'].append(sample['resource_metadata']['name'])
+                labels['values'].append(resource_metadata['name'])
+
+        # NOTE(jwysogla): The prometheus_client library doesn't support
+        # variable count of labels for the same metric. That's why the
+        # prometheus exporter cannot support custom metric labels added
+        # with the --property metering.<label_key>=<label_value> when
+        # creating a server. This still works with publishers though.
+        # The "server_group" label is used for autoscaling and so it's
+        # the only one getting parsed. To always have the same number
+        # of labels, it's added to all metrics and where there isn't a
+        # value defined, it's substituted with "none".
+        if (resource_metadata.get('user_metadata', '') != '' and
+                resource_metadata['user_metadata']
+                .get('server_group', '') != '' and
+                resource_metadata['user_metadata']
+                .get('server_group') is not None):
+            labels['keys'].append('server_group')
+            labels['values'].append(resource_metadata['user_metadata']
+                                    ['server_group'])
+        else:
+            labels['keys'].append('server_group')
+            labels['values'].append('none')
 
     return labels

ceilometer/tests/unit/test_prom_exporter.py

@@ -72,7 +72,10 @@ class TestPromExporter(base.BaseTestCase):
                 'disk_gb': 1,
                 'ephemeral_gb': 0,
                 'root_gb': 1,
-                'disk_name': 'vda'
+                'disk_name': 'vda',
+                'user_metadata': {
+                    'custom_label': 'custom value'
+                }
             },
             'message_id': '078029c7-2ee8-11ef-a915-bd45e2085de3',
             'monotonic_time': 1819980.112406547,
@@ -151,7 +154,10 @@ class TestPromExporter(base.BaseTestCase):
                 'checksum': '7734eb3945297adc90ddc6cebe8bb082',
                 'min_ram': 0,
                 'tags': [],
-                'virtual_size': 117440512
+                'virtual_size': 117440512,
+                'user_metadata': {
+                    'server_group': 'server_group123'
+                }
             },
             'message_id': '19f8f78a-2ee9-11ef-a95f-bd45e2085de3',
             'monotonic_time': None,
@@ -194,7 +200,8 @@ class TestPromExporter(base.BaseTestCase):
                          'resource': 'f9276c96-8a12-432b-96a1-559d70715f97',
                          'resource_name': 'cirros2',
                          'type': 'size',
-                         'unit': 'B'}
+                         'unit': 'B',
+                         'server_group': 'server_group123'}
         sample_dict_2 = {'counter': 'memory.usage',
                          'memory': 'e536fff6-b20d-4aa5-ac2f-d15ac8b3af63',
                          'project': 'd965489b7f894cbda89cd2e25bfd85a0',
@@ -204,7 +211,8 @@ class TestPromExporter(base.BaseTestCase):
                          'type': 'usage',
                          'unit': 'MB',
                          'user': '6e7d71415cd5401cbe103829c9c5dec2',
-                         'vm_instance': 'e0d297f5df3b62ec73c8d42b'}
+                         'vm_instance': 'e0d297f5df3b62ec73c8d42b',
+                         'server_group': 'none'}
         self.assertEqual(16344576,
                          prom_exporter.CEILOMETER_REGISTRY.
                          get_sample_value('ceilometer_image_size',
@@ -219,7 +227,7 @@ class TestPromExporter(base.BaseTestCase):
         slabels1['keys'] = ['disk', 'publisher', 'type', 'counter',
                             'project', 'user', 'unit', 'resource',
                             'vm_instance', 'resource_name',
-                            'resource_name']
+                            'resource_name', 'server_group']
         slabels1['values'] = ['read', 'ceilometer', 'device',
                               'disk.device.read.latency',
                               'd965489b7f894cbda89cd2e25bfd85a0',
@@ -227,18 +235,33 @@ class TestPromExporter(base.BaseTestCase):
                               'ns',
                               'e536fff6-b20d-4aa5-ac2f-d15ac8b3af63-vda',
                               'e0d297f5df3b62ec73c8d42b', 'myserver',
-                              'myserver:instance-00000002']
+                              'myserver:instance-00000002', 'none']
         label1 = prom_exporter._gen_labels(self.test_data[0])
         self.assertDictEqual(label1, slabels1)
 
         slabels2 = dict(keys=[], values=[])
-        slabels2['keys'] = ['image', 'publisher', 'type', 'counter',
+        slabels2['keys'] = ['memory', 'publisher', 'type', 'counter',
+                            'project', 'user', 'unit', 'resource',
+                            'vm_instance', 'resource_name',
+                            'resource_name', 'server_group']
+        slabels2['values'] = ['e536fff6-b20d-4aa5-ac2f-d15ac8b3af63',
+                              'ceilometer', 'usage', 'memory.usage',
+                              'd965489b7f894cbda89cd2e25bfd85a0',
+                              '6e7d71415cd5401cbe103829c9c5dec2', 'MB',
+                              'e536fff6-b20d-4aa5-ac2f-d15ac8b3af63',
+                              'e0d297f5df3b62ec73c8d42b',
+                              'myserver', 'myserver:instance-00000002', 'none']
+        label2 = prom_exporter._gen_labels(self.test_data[1])
+        self.assertDictEqual(label2, slabels2)
+
+        slabels3 = dict(keys=[], values=[])
+        slabels3['keys'] = ['image', 'publisher', 'type', 'counter',
                             'project', 'unit', 'resource',
-                            'resource_name']
+                            'resource_name', 'server_group']
-        slabels2['values'] = ['f9276c96-8a12-432b-96a1-559d70715f97',
+        slabels3['values'] = ['f9276c96-8a12-432b-96a1-559d70715f97',
                               'ceilometer', 'size', 'image.size',
                               'd965489b7f894cbda89cd2e25bfd85a0', 'B',
                               'f9276c96-8a12-432b-96a1-559d70715f97',
-                              'cirros2']
+                              'cirros2', 'server_group123']
-        label2 = prom_exporter._gen_labels(self.test_data[2])
+        label3 = prom_exporter._gen_labels(self.test_data[2])
-        self.assertDictEqual(label2, slabels2)
+        self.assertDictEqual(label3, slabels3)