fix(sdk-metrics): Update default Histogram's boundary to match OTEL's…

… spec (open-telemetry#3893)
dynatrace-oss-contrib · Jun 26, 2023 · 4fb7f00 · 4fb7f00
1 parent 186815b
commit 4fb7f00
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :bug: (Bug Fix)
 
+* fix(sdk-metrics): Update default Histogram's boundary to match OTEL's spec [#3893](https://github.com/open-telemetry/opentelemetry-js/pull/3893/) @chigia001
+
 ### :books: (Refine Doc)
 
 ### :house: (Internal)

diff --git a/experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusExporter.test.ts b/experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusExporter.test.ts
@@ -514,7 +514,12 @@ describe('PrometheusExporter', () => {
         `test_histogram_bucket{key1="attributeValue1",le="100"} 1 ${mockedHrTimeMs}`,
         `test_histogram_bucket{key1="attributeValue1",le="250"} 1 ${mockedHrTimeMs}`,
         `test_histogram_bucket{key1="attributeValue1",le="500"} 1 ${mockedHrTimeMs}`,
+        `test_histogram_bucket{key1="attributeValue1",le="750"} 1 ${mockedHrTimeMs}`,
         `test_histogram_bucket{key1="attributeValue1",le="1000"} 1 ${mockedHrTimeMs}`,
+        `test_histogram_bucket{key1="attributeValue1",le="2500"} 1 ${mockedHrTimeMs}`,
+        `test_histogram_bucket{key1="attributeValue1",le="5000"} 1 ${mockedHrTimeMs}`,
+        `test_histogram_bucket{key1="attributeValue1",le="7500"} 1 ${mockedHrTimeMs}`,
+        `test_histogram_bucket{key1="attributeValue1",le="10000"} 1 ${mockedHrTimeMs}`,
         `test_histogram_bucket{key1="attributeValue1",le="+Inf"} 1 ${mockedHrTimeMs}`,
         '',
       ]);

diff --git a/packages/sdk-metrics/src/view/Aggregation.ts b/packages/sdk-metrics/src/view/Aggregation.ts
@@ -107,7 +107,7 @@ export class LastValueAggregation extends Aggregation {
  */
 export class HistogramAggregation extends Aggregation {
   private static DEFAULT_INSTANCE = new HistogramAggregator(
-    [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
+    [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000],
     true
   );
   createAggregator(_instrument: InstrumentDescriptor) {

diff --git a/packages/sdk-metrics/test/Instruments.test.ts b/packages/sdk-metrics/test/Instruments.test.ts
@@ -297,8 +297,11 @@ describe('Instruments', () => {
             attributes: {},
             value: {
               buckets: {
-                boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
-                counts: [0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0],
+                boundaries: [
+                  0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
+                  7500, 10000,
+                ],
+                counts: [0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
               },
               count: 2,
               sum: 10,
@@ -310,8 +313,11 @@ describe('Instruments', () => {
             attributes: { foo: 'bar' },
             value: {
               buckets: {
-                boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
-                counts: [0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0],
+                boundaries: [
+                  0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
+                  7500, 10000,
+                ],
+                counts: [0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
               },
               count: 2,
               sum: 100,
@@ -352,8 +358,11 @@ describe('Instruments', () => {
             attributes: {},
             value: {
               buckets: {
-                boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
-                counts: [0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 0],
+                boundaries: [
+                  0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
+                  7500, 10000,
+                ],
+                counts: [0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0],
               },
               count: 2,
               sum: 110,
@@ -379,8 +388,11 @@ describe('Instruments', () => {
             attributes: {},
             value: {
               buckets: {
-                boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
-                counts: [0, 0, 0, 2, 0, 0, 1, 1, 0, 0, 0],
+                boundaries: [
+                  0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
+                  7500, 10000,
+                ],
+                counts: [0, 0, 0, 2, 0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0],
               },
               count: 4,
               sum: 220,
@@ -422,8 +434,11 @@ describe('Instruments', () => {
             attributes: {},
             value: {
               buckets: {
-                boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
-                counts: [0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0],
+                boundaries: [
+                  0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
+                  7500, 10000,
+                ],
+                counts: [0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
               },
               count: 2,
               sum: 10.1,
@@ -435,8 +450,11 @@ describe('Instruments', () => {
             attributes: { foo: 'bar' },
             value: {
               buckets: {
-                boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
-                counts: [0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0],
+                boundaries: [
+                  0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
+                  7500, 10000,
+                ],
+                counts: [0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
               },
               count: 2,
               sum: 100.1,

diff --git a/packages/sdk-metrics/test/view/Aggregation.test.ts b/packages/sdk-metrics/test/view/Aggregation.test.ts
@@ -135,7 +135,10 @@ describe('HistogramAggregator', () => {
       assert(aggregator instanceof HistogramAggregator);
       assert.deepStrictEqual(
         aggregator['_boundaries'],
-        [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000]
+        [
+          0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500,
+          10000,
+        ]
       );
     });
   });