From b7c2c7ca965659255e9a611666e58b024c27d804 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Weing=C3=A4rtner?= Date: Sun, 11 Sep 2022 17:02:11 -0300 Subject: Properly handle 'resource_id' as None for Gnocchi publisher This issue is related to [1]. In Python 3 (I did not check exactly in which version), the following code was throwing an error `data.sort(key=operator.attrgetter('resource_id'))`. Therefore, this patch is proposing a solution for such situations to properly handle samples where the `resource_id` is None. Of course, `resource_id` cannot be None in Gnocchi. However, that can be properly handled by removing the metric to be pushed from the `gnocchi_resource.yml` file. Which is what we were doing when we proposed [1]. The problem is that the sort is happening before that part of the code is executed, to decide if the sample should be ignored or not. [1] https://review.opendev.org/c/openstack/ceilometer/+/746717 Change-Id: Ie8eb42df3d5b9505160c9e9d6b86bdaa9a02d16a --- ceilometer/publisher/gnocchi.py | 13 ++++++++- ceilometer/tests/unit/publisher/test_gnocchi.py | 36 ++++++++++++++++--------- 2 files changed, 36 insertions(+), 13 deletions(-) (limited to 'ceilometer') diff --git a/ceilometer/publisher/gnocchi.py b/ceilometer/publisher/gnocchi.py index 19d7d54b..1f0edaa7 100644 --- a/ceilometer/publisher/gnocchi.py +++ b/ceilometer/publisher/gnocchi.py @@ -327,7 +327,18 @@ class GnocchiPublisher(publisher.ConfigPublisherBase): # NOTE(sileht): skip sample generated by gnocchi itself data = [s for s in data if not self._is_gnocchi_activity(s)] - data.sort(key=operator.attrgetter('resource_id')) + + def value_to_sort(object_to_sort): + value = object_to_sort.resource_id + if not value: + LOG.debug("Resource ID was not defined for sample data [%s]. " + "Therefore, we will use an empty string as the " + "resource ID.", object_to_sort) + value = '' + + return value + + data.sort(key=value_to_sort) resource_grouped_samples = itertools.groupby( data, key=operator.attrgetter('resource_id')) diff --git a/ceilometer/tests/unit/publisher/test_gnocchi.py b/ceilometer/tests/unit/publisher/test_gnocchi.py index 236da69b..a763925d 100644 --- a/ceilometer/tests/unit/publisher/test_gnocchi.py +++ b/ceilometer/tests/unit/publisher/test_gnocchi.py @@ -375,18 +375,30 @@ class PublisherTest(base.BaseTestCase): @mock.patch('ceilometer.publisher.gnocchi.GnocchiPublisher' '.batch_measures') def test_unhandled_meter_with_no_resource_id(self, fake_batch): - samples = [sample.Sample( - name='unknown.meter', - unit='GB', - type=sample.TYPE_GAUGE, - volume=2, - user_id='test_user', - project_id='test_project', - source='openstack', - timestamp='2014-05-08 20:23:48.028195', - resource_id=None, - resource_metadata={} - )] + samples = [ + sample.Sample( + name='unknown.meter', + unit='GB', + type=sample.TYPE_GAUGE, + volume=2, + user_id='test_user', + project_id='test_project', + source='openstack', + timestamp='2014-05-08 20:23:48.028195', + resource_id=None, + resource_metadata={}), + sample.Sample( + name='unknown.meter', + unit='GB', + type=sample.TYPE_GAUGE, + volume=2, + user_id='test_user', + project_id='test_project', + source='openstack', + timestamp='2014-05-08 20:23:48.028195', + resource_id="Some-other-resource-id", + resource_metadata={}) + ] url = netutils.urlsplit("gnocchi://") d = gnocchi.GnocchiPublisher(self.conf.conf, url) d._already_checked_archive_policies = True -- cgit v1.2.1