Skip to content

Omit _sum for negative-bucket histograms in multiprocess mode #1254

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

Omit _sum for negative-bucket histograms in multiprocess mode #1254

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: 3 additions & 0 deletions docs/content/instrumenting/histogram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ A Histogram exposes three time series per metric:
- `<name>_sum` — sum of all observed values
- `<name>_count` — total number of observations

If the lowest bucket bound is negative, `_sum` is left out, because OpenMetrics
1.0 does not allow a sum for histograms with negative buckets.

## Constructor

```python
Expand Down
3 changes: 3 additions & 0 deletions prometheus_client/multiprocess.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,9 @@ def _accumulate_metrics(metrics, accumulate):
samples[labels][sample_key] = value
if accumulate:
samples[labels][(metric.name + '_count', labels)] = acc
# Like Histogram, don't include sum if there are negative buckets.
if min(values) < 0:
samples[labels].pop((metric.name + '_sum', labels), None)

# Convert to correct sample format.
metric.samples = []
Expand Down
12 changes: 12 additions & 0 deletions tests/test_multiprocess.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,18 @@ def test_histogram_nan(self):
self.assertEqual(2, self.registry.get_sample_value('h_count'))
self.assertTrue(math.isnan(self.registry.get_sample_value('h_sum')))

def test_histogram_negative_buckets(self):
h1 = Histogram('h', 'help', labelnames=['l'], buckets=[-1, 0, 1], registry=None)
values.ValueClass = MultiProcessValue(lambda: 456)
h2 = Histogram('h', 'help', labelnames=['l'], buckets=[-1, 0, 1], registry=None)
h1.labels('x').observe(-0.5)
h2.labels('x').observe(2)

self.assertEqual(1, self.registry.get_sample_value('h_bucket', {'l': 'x', 'le': '0.0'}))
self.assertEqual(2, self.registry.get_sample_value('h_bucket', {'l': 'x', 'le': '+Inf'}))
self.assertEqual(2, self.registry.get_sample_value('h_count', {'l': 'x'}))
self.assertIsNone(self.registry.get_sample_value('h_sum', {'l': 'x'}))

def test_gauge_all(self):
g1 = Gauge('g', 'help', registry=None)
values.ValueClass = MultiProcessValue(lambda: 456)
Expand Down