Skip to content

Add a clear() method to metric objects to remove all labelsets #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 2, 2021
Merged

Add a clear() method to metric objects to remove all labelsets #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions prometheus_client/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@ def remove(self, *labelvalues):
with self._lock:
del self._metrics[labelvalues]

def clear(self):
"""Remove all labelsets from the metric"""
with self._lock:
self._metrics = {}

def _samples(self):
if self._is_parent():
return self._multi_samples()
Expand Down
9 changes: 9 additions & 0 deletions tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,15 @@ def test_remove(self):
self.assertEqual(None, self.registry.get_sample_value('c_total', {'l': 'x'}))
self.assertEqual(2, self.registry.get_sample_value('c_total', {'l': 'y'}))

def test_clear(self):
self.counter.labels('x').inc()
self.counter.labels('y').inc(2)
self.assertEqual(1, self.registry.get_sample_value('c_total', {'l': 'x'}))
self.assertEqual(2, self.registry.get_sample_value('c_total', {'l': 'y'}))
self.counter.clear()
self.assertEqual(None, self.registry.get_sample_value('c_total', {'l': 'x'}))
self.assertEqual(None, self.registry.get_sample_value('c_total', {'l': 'y'}))

def test_incorrect_label_count_raises(self):
self.assertRaises(ValueError, self.counter.labels)
self.assertRaises(ValueError, self.counter.labels, 'a', 'b')
Expand Down