Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions prometheus_client/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ def unregister(self, collector: Collector) -> None:
del self._names_to_collectors[name]
del self._collector_to_names[collector]

def clear(self) -> None:
"""Remove all collectors from the registry."""
with self._lock:
self._collector_to_names.clear()
self._names_to_collectors.clear()
self._target_info = None

def _get_names(self, collector):
"""Get names of timeseries the collector produces and clashes with."""
desc_func = None
Expand Down
27 changes: 27 additions & 0 deletions tests/test_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -946,6 +946,33 @@ def test_unregister_works(self):
registry.unregister(s)
Gauge('s_count', 'help', registry=registry)

def test_clear_works(self):
registry = CollectorRegistry()
g1 = Gauge('g1', 'help', registry=registry)
g2 = Gauge('g2', 'help', registry=registry)
c = Counter('c_total', 'help', registry=registry)

# Verify metrics are registered
g1.set(42)
g2.set(43)
c.inc()
self.assertEqual(42, registry.get_sample_value('g1'))
self.assertEqual(43, registry.get_sample_value('g2'))
self.assertEqual(1, registry.get_sample_value('c_total'))

# Clear the registry
registry.clear()

# Verify all metrics are removed
self.assertEqual(None, registry.get_sample_value('g1'))
self.assertEqual(None, registry.get_sample_value('g2'))
self.assertEqual(None, registry.get_sample_value('c_total'))

# Verify we can register new metrics with the same names
Gauge('g1', 'help', registry=registry)
Gauge('g2', 'help', registry=registry)
Counter('c_total', 'help', registry=registry)

def custom_collector(self, metric_family, registry):
class CustomCollector:
def collect(self):
Expand Down