Skip to content

Reject Enum labels that collide with prefixed metric names #1226

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

Open
zhechen-cs wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Reject Enum labels that collide with prefixed metric names #1226

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
3 changes: 2 additions & 1 deletion prometheus_client/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -761,6 +761,7 @@ class Enum(MetricWrapperBase):
e.state('running')

The first listed state will be the default.
The full metric name, including namespace and subsystem, is reserved as a label name.
Enum metrics do not work in multiprocess mode.
"""
_type = 'stateset'
Expand All @@ -776,7 +777,7 @@ def __init__(self,
_labelvalues: Optional[Sequence[str]] = None,
states: Optional[Sequence[str]] = None,
):
if name in labelnames:
if name in labelnames or _build_full_name(self._type, name, namespace, subsystem, unit) in labelnames:
raise ValueError(f'Overlapping labels for Enum metric: {name}')
if not states:
raise ValueError(f'No states provided for Enum metric: {name}')
Expand Down
17 changes: 17 additions & 0 deletions tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,6 +609,23 @@ def test_failed_init_does_not_pollute_registry(self):
Enum('task_state', 'help', states=['a', 'b'], registry=registry)
self.assertEqual(1, registry.get_sample_value('task_state', {'task_state': 'a'}))

def test_prefixed_name_does_not_overlap_labels(self):
for namespace, subsystem in [('app', ''), ('', 'worker'), ('app', 'worker')]:
with self.subTest(namespace=namespace, subsystem=subsystem):
registry = CollectorRegistry()
name = '_'.join(part for part in (namespace, subsystem, 'state') if part)
with self.assertRaisesRegex(ValueError, 'Overlapping labels'):
Enum('state', 'help', namespace=namespace, subsystem=subsystem,
labelnames=[name], states=['a', 'b'], registry=registry)
self.assertEqual([], list(registry.collect()))

metric = Enum('state', 'help', namespace=namespace, subsystem=subsystem,
labelnames=['tenant'], states=['a', 'b'], registry=registry)
metric.labels('one').state('a')
metric.labels('two').state('b')
self.assertEqual(1, registry.get_sample_value(name, {'tenant': 'one', name: 'a'}))
self.assertEqual(1, registry.get_sample_value(name, {'tenant': 'two', name: 'b'}))


class TestMetricWrapper(unittest.TestCase):
def setUp(self):
Expand Down