From ae1185dbcdc41d666f7e9f47474ea8996dbc8968 Mon Sep 17 00:00:00 2001 From: Andrew Date: Thu, 8 Oct 2020 16:31:58 +0300 Subject: [PATCH] fix: make prometheus histogram export cumulative (#1570) Co-authored-by: legendecas Co-authored-by: Daniel Dyla --- .../src/PrometheusSerializer.ts | 5 +++- .../test/PrometheusSerializer.test.ts | 25 +++++++++++-------- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts b/packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts index 7e70eb986f..bceb459b6a 100644 --- a/packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts +++ b/packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts @@ -239,12 +239,15 @@ export class PrometheusSerializer { undefined ); } + + let cumulativeSum = 0; for (const [idx, val] of value.buckets.counts.entries()) { + cumulativeSum += val; const upperBound = value.buckets.boundaries[idx]; results += stringify( name + '_bucket', record.labels, - val, + cumulativeSum, this._appendTimestamp ? timestamp : undefined, { le: upperBound === undefined ? '+Inf' : String(upperBound), diff --git a/packages/opentelemetry-exporter-prometheus/test/PrometheusSerializer.test.ts b/packages/opentelemetry-exporter-prometheus/test/PrometheusSerializer.test.ts index b706e635d9..ed61d628b4 100644 --- a/packages/opentelemetry-exporter-prometheus/test/PrometheusSerializer.test.ts +++ b/packages/opentelemetry-exporter-prometheus/test/PrometheusSerializer.test.ts @@ -168,8 +168,8 @@ describe('PrometheusSerializer', () => { `test_sum{foo1="bar1",foo2="bar2"} 5 ${mockedHrTimeMs}\n` + `test_bucket{foo1="bar1",foo2="bar2",le="1"} 0 ${mockedHrTimeMs}\n` + `test_bucket{foo1="bar1",foo2="bar2",le="10"} 1 ${mockedHrTimeMs}\n` + - `test_bucket{foo1="bar1",foo2="bar2",le="100"} 0 ${mockedHrTimeMs}\n` + - `test_bucket{foo1="bar1",foo2="bar2",le="+Inf"} 0 ${mockedHrTimeMs}\n` + `test_bucket{foo1="bar1",foo2="bar2",le="100"} 1 ${mockedHrTimeMs}\n` + + `test_bucket{foo1="bar1",foo2="bar2",le="+Inf"} 1 ${mockedHrTimeMs}\n` ); }); @@ -196,8 +196,8 @@ describe('PrometheusSerializer', () => { 'test_sum{foo1="bar1",foo2="bar2"} 5\n' + 'test_bucket{foo1="bar1",foo2="bar2",le="1"} 0\n' + 'test_bucket{foo1="bar1",foo2="bar2",le="10"} 1\n' + - 'test_bucket{foo1="bar1",foo2="bar2",le="100"} 0\n' + - 'test_bucket{foo1="bar1",foo2="bar2",le="+Inf"} 0\n' + 'test_bucket{foo1="bar1",foo2="bar2",le="100"} 1\n' + + 'test_bucket{foo1="bar1",foo2="bar2",le="+Inf"} 1\n' ); }); }); @@ -302,7 +302,7 @@ describe('PrometheusSerializer', () => { describe('with HistogramAggregator', () => { mockAggregator(HistogramAggregator); - it('serialize metric record with MinMaxLastSumCountAggregator aggregator', async () => { + it('serialize metric record with HistogramAggregator aggregator, cumulative', async () => { const serializer = new PrometheusSerializer(); const batcher = new ExactBatcher(HistogramAggregator, [1, 10, 100]); @@ -311,6 +311,9 @@ describe('PrometheusSerializer', () => { description: 'foobar', }) as ValueRecorderMetric; recorder.bind({ val: '1' }).record(5); + recorder.bind({ val: '1' }).record(50); + recorder.bind({ val: '1' }).record(120); + recorder.bind({ val: '2' }).record(5); const records = await recorder.getMetricRecord(); @@ -323,18 +326,18 @@ describe('PrometheusSerializer', () => { result, '# HELP test foobar\n' + '# TYPE test histogram\n' + - `test_count{val="1"} 1 ${mockedHrTimeMs}\n` + - `test_sum{val="1"} 5 ${mockedHrTimeMs}\n` + + `test_count{val="1"} 3 ${mockedHrTimeMs}\n` + + `test_sum{val="1"} 175 ${mockedHrTimeMs}\n` + `test_bucket{val="1",le="1"} 0 ${mockedHrTimeMs}\n` + `test_bucket{val="1",le="10"} 1 ${mockedHrTimeMs}\n` + - `test_bucket{val="1",le="100"} 0 ${mockedHrTimeMs}\n` + - `test_bucket{val="1",le="+Inf"} 0 ${mockedHrTimeMs}\n` + + `test_bucket{val="1",le="100"} 2 ${mockedHrTimeMs}\n` + + `test_bucket{val="1",le="+Inf"} 3 ${mockedHrTimeMs}\n` + `test_count{val="2"} 1 ${mockedHrTimeMs}\n` + `test_sum{val="2"} 5 ${mockedHrTimeMs}\n` + `test_bucket{val="2",le="1"} 0 ${mockedHrTimeMs}\n` + `test_bucket{val="2",le="10"} 1 ${mockedHrTimeMs}\n` + - `test_bucket{val="2",le="100"} 0 ${mockedHrTimeMs}\n` + - `test_bucket{val="2",le="+Inf"} 0 ${mockedHrTimeMs}\n` + `test_bucket{val="2",le="100"} 1 ${mockedHrTimeMs}\n` + + `test_bucket{val="2",le="+Inf"} 1 ${mockedHrTimeMs}\n` ); }); });