migrate from explicit buckets to "native" exponential histograms

Author: bobymicroby

.github/workflows/ci.yml

@@ -64,3 +64,4 @@ jobs:
         env:
           OTEL_EXPORTER_OTLP_PROTOCOL: 'http/protobuf'
           ACTIONS_STEP_DEBUG: 'true'
+          OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION: 'base2_exponential_bucket_histogram'

badges/coverage.svg

@@ -31,19 +31,39 @@ exports[`MetricsSubmitter should configures histogram with explicit buckets 1`]
                 "value": {
                   "buckets": {
                     "boundaries": [
-                      0.1,
-                      0.5,
-                      1,
+                      0,
                       5,
                       10,
+                      25,
+                      50,
+                      75,
+                      100,
+                      250,
+                      500,
+                      750,
+                      1000,
+                      2500,
+                      5000,
+                      7500,
+                      10000,
                     ],
                     "counts": [
-                      0,
                       0,
                       1,
                       0,
                       0,
                       0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
+                      0,
                     ],
                   },
                   "count": 1,
@@ -54,15 +74,7 @@ exports[`MetricsSubmitter should configures histogram with explicit buckets 1`]
               },
             ],
             "descriptor": {
-              "advice": {
-                "explicitBucketBoundaries": [
-                  0.1,
-                  0.5,
-                  1,
-                  5,
-                  10,
-                ],
-              },
+              "advice": {},
               "description": "Test metric",
               "name": "test-namespace.v1.test.duration",
               "type": "HISTOGRAM",

dist/index.js

@@ -19,7 +19,7 @@ import {
   ATTR_SERVICE_NAMESPACE
 } from '@opentelemetry/semantic-conventions/incubating'
 
-const DEFAULT_EXPORT_INTERVAL_MS = 1000
+const DEFAULT_EXPORT_INTERVAL_MS = 15000
 const DEFAULT_TIMEOUT_MS = 30000
 import {
   DiagConsoleLogger,
@@ -94,7 +94,7 @@ export async function run(): Promise<void> {
 
     const metricsNamespace = core.getInput('metrics-namespace') || 'cae'
 
-    const metricsVersion = core.getInput('metrics-version') || 'v1'
+    const metricsVersion = core.getInput('metrics-version') || 'v2'
 
     const config: TMetricsConfig = {
       serviceName,

dist/index.js.map

@@ -124,12 +124,8 @@ describe('generateMetrics', () => {
       (m) => m.metricName === 'test.suite.duration'
     )
 
-    expect(testDuration?.buckets).toEqual([
-      0.01, 0.03, 0.1, 0.3, 1, 3, 10, 30, 100
-    ])
-    expect(suiteDuration?.buckets).toEqual([
-      0.01, 0.03, 0.1, 0.3, 1, 3, 10, 30, 100
-    ])
+    expect(testDuration).toBeDefined()
+    expect(suiteDuration).toBeDefined()
   })
 
   it('generates metrics for all test statuses', () => {

src/__snapshots__/metrics-submitter.test.ts.snap

@@ -18,7 +18,6 @@ export interface TMetricDataPoint {
   readonly attributes: Readonly<Record<string, string>>
   readonly description: string
   readonly unit: string | undefined
-  readonly buckets: readonly number[] | undefined
 }
 
 export const generateMetrics = (
@@ -53,8 +52,7 @@ const generateSuiteMetrics = (
     value: suite.totals.time,
     attributes: suiteAttributes,
     description: 'Test suite execution time (from XML time attribute)',
-    unit: 's',
-    buckets: [0.01, 0.03, 0.1, 0.3, 1, 3, 10, 30, 100]
+    unit: 's'
   })
 
   metrics.push({
@@ -63,8 +61,7 @@ const generateSuiteMetrics = (
     value: suite.totals.cumulativeTime,
     attributes: suiteAttributes,
     description: 'Test suite cumulative time (calculated from child elements)',
-    unit: 's',
-    buckets: [0.01, 0.03, 0.1, 0.3, 1, 3, 10, 30, 100]
+    unit: 's'
   })
 
   const statusCounts = [
@@ -85,8 +82,7 @@ const generateSuiteMetrics = (
           'test.status': status
         },
         description: 'Current test count per suite by status',
-        unit: '{test}',
-        buckets: undefined
+        unit: '{test}'
       })
     }
   }
@@ -123,8 +119,7 @@ const generateTestCaseMetrics = (
     value: testCase.time,
     attributes: testAttributes,
     description: 'Individual test execution time',
-    unit: 's',
-    buckets: [0.01, 0.03, 0.1, 0.3, 1, 3, 10, 30, 100]
+    unit: 's'
   })
 
   metrics.push({
@@ -133,8 +128,7 @@ const generateTestCaseMetrics = (
     value: 1,
     attributes: testAttributes,
     description: 'Test execution count by status',
-    unit: '{test}',
-    buckets: undefined
+    unit: '{test}'
   })
 
   switch (testCase.result.status) {
@@ -149,8 +143,7 @@ const generateTestCaseMetrics = (
             'failure.type': testCase.result.type
           },
           description: 'Test failures by type',
-          unit: '{failure}',
-          buckets: undefined
+          unit: '{failure}'
         })
       }
       break
@@ -166,8 +159,7 @@ const generateTestCaseMetrics = (
             'error.type': testCase.result.type
           },
           description: 'Test errors by type',
-          unit: '{error}',
-          buckets: undefined
+          unit: '{error}'
         })
       }
       break

src/main.ts

@@ -94,7 +94,6 @@ describe('MetricsSubmitter', () => {
     attributes: { 'test.name': 'example' },
     description: 'Test metric',
     unit: '{test}',
-    buckets: undefined,
     ...overrides
   })
 
@@ -150,8 +149,7 @@ describe('MetricsSubmitter', () => {
       metrics: [
         createDataPoint({
           metricName: 'test.duration',
-          metricType: 'histogram',
-          buckets: [0.1, 0.5, 1, 5, 10]
+          metricType: 'histogram'
         })
       ]
     },

src/metrics-generator.test.ts

@@ -72,12 +72,6 @@ export class MetricsSubmitter {
       unit: dataPoint.unit
     }
 
-    if (dataPoint.buckets) {
-      options.advice = {
-        explicitBucketBoundaries: dataPoint.buckets.concat()
-      }
-    }
-
     return options
   }