Skip to content

Reject NaN increments on Counter #1256

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
WatchTree-19 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Reject NaN increments on Counter #1256

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
2 changes: 2 additions & 0 deletions prometheus_client/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,8 @@ def inc(self, amount: float = 1, exemplar: Optional[Dict[str, str]] = None) -> N
self._raise_if_not_observable()
if amount < 0:
raise ValueError('Counters can only be incremented by non-negative amounts.')
if math.isnan(amount):
raise ValueError('Counters cannot be incremented by NaN.')
self._value.inc(amount)
if exemplar:
_validate_exemplar(exemplar)
Expand Down
5 changes: 5 additions & 0 deletions tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ def test_clear_without_labels_is_noop(self):
def test_negative_increment_raises(self):
self.assertRaises(ValueError, self.counter.inc, -1)

def test_nan_increment_raises(self):
self.counter.inc(2)
self.assertRaises(ValueError, self.counter.inc, float('nan'))
self.assertEqual(2, self.registry.get_sample_value('c_total'))

def test_function_decorator(self):
@self.counter.count_exceptions(ValueError)
def f(r):
Expand Down