feat(sdk-metrics)!: drop View and Aggregation for options

CHANGELOG_NEXT.md

@@ -11,6 +11,7 @@
 * feat(sdk-metrics)!: remove MeterProvider.addMetricReader() in favor of constructor option [#4419](https://github.com/open-telemetry/opentelemetry-js/pull/4419) @pichlermarc
 * feat(sdk-metrics)!: replace attributeKeys with custom processors option [#4532](https://github.com/open-telemetry/opentelemetry-js/pull/4532) @pichlermarc
 * refactor(sdk-trace-base)!: replace `SpanAttributes` with `Attributes` [#5009](https://github.com/open-telemetry/opentelemetry-js/pull/5009) @david-luna
+* feat(sdk-metrics)!: drop `View` and `Aggregation` in favor of `ViewOptions` and `AggregationOption` [#4931](https://github.com/open-telemetry/opentelemetry-js/pull/4931) @pichlermarc
 
 ### :rocket: (Enhancement)
 

experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/test/metricsHelper.ts

@@ -27,10 +27,9 @@ import * as assert from 'assert';
 import * as grpc from '@grpc/grpc-js';
 import { VERSION } from '@opentelemetry/core';
 import {
-  ExplicitBucketHistogramAggregation,
+  AggregationType,
   MeterProvider,
   MetricReader,
-  View,
 } from '@opentelemetry/sdk-metrics';
 import {
   encodeAsString,
@@ -72,10 +71,13 @@ export function setUp() {
   meterProvider = new MeterProvider({
     resource: testResource,
     views: [
-      new View({
-        aggregation: new ExplicitBucketHistogramAggregation([0, 100]),
+      {
+        aggregation: {
+          type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+          options: { boundaries: [0, 100] },
+        },
         instrumentName: 'int-histogram',
-      }),
+      },
     ],
     readers: [reader],
   });

experimental/packages/opentelemetry-exporter-metrics-otlp-http/src/OTLPMetricExporterBase.ts

@@ -21,8 +21,9 @@
   InstrumentType,
   PushMetricExporter,
   ResourceMetrics,
-  Aggregation,
   AggregationSelector,
+  AggregationOption,
+  AggregationType,
 } from '@opentelemetry/sdk-metrics';
 import {
   AggregationTemporalityPreference,
@@ -113,7 +114,11 @@
   if (config?.aggregationPreference) {
     return config.aggregationPreference;
   } else {
-    return (_instrumentType: any) => Aggregation.Default();
+    return (_instrumentType: any) => {
+      return {
+        type: AggregationType.DEFAULT,
+      };
+    };
   }
 }
 
@@ -148,7 +153,7 @@
     return Promise.resolve();
   }
 
-  selectAggregation(instrumentType: InstrumentType): Aggregation {
+  selectAggregation(instrumentType: InstrumentType): AggregationOption {
     return this._aggregationSelector(instrumentType);
   }
 

experimental/packages/opentelemetry-exporter-metrics-otlp-http/test/metricsHelper.ts

@@ -28,10 +28,10 @@ import { Resource } from '@opentelemetry/resources';
 import * as assert from 'assert';
 import { InstrumentationScope, VERSION } from '@opentelemetry/core';
 import {
-  ExplicitBucketHistogramAggregation,
+  AggregationType,
   MeterProvider,
   MetricReader,
-  View,
+  ViewOptions,
 } from '@opentelemetry/sdk-metrics';
 import {
   encodeAsString,
@@ -59,10 +59,15 @@ class TestMetricReader extends MetricReader {
   }
 }
 
-export const HISTOGRAM_AGGREGATION_VIEW = new View({
-  aggregation: new ExplicitBucketHistogramAggregation([0, 100]),
+export const HISTOGRAM_AGGREGATION_VIEW: ViewOptions = {
+  aggregation: {
+    type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+    options: {
+      boundaries: [0, 100],
+    },
+  },
   instrumentName: 'int-histogram',
-});
+};
 
 const defaultResource = Resource.default().merge(
   new Resource({
@@ -83,7 +88,7 @@ export async function collect() {
   return (await reader.collect())!;
 }
 
-export function setUp(views?: View[]) {
+export function setUp(views?: ViewOptions[]) {
   reader = new TestMetricReader();
   meterProvider = new MeterProvider({
     resource: defaultResource,

experimental/packages/opentelemetry-exporter-metrics-otlp-http/test/node/CollectorMetricExporter.test.ts

@@ -43,9 +43,9 @@ import {
 } from '../metricsHelper';
 import { MockedResponse } from './nodeHelpers';
 import {
-  Aggregation,
+  AggregationOption,
   AggregationTemporality,
-  ExplicitBucketHistogramAggregation,
+  AggregationType,
   InstrumentType,
   ResourceMetrics,
 } from '@opentelemetry/sdk-metrics';
@@ -225,9 +225,13 @@ describe('OTLPMetricExporter - node with json over http', () => {
 
   describe('aggregation', () => {
     it('aggregationSelector calls the selector supplied to the constructor', () => {
-      const aggregation = new ExplicitBucketHistogramAggregation([
-        0, 100, 100000,
-      ]);
+      const aggregation: AggregationOption = {
+        type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+        options: {
+          boundaries: [0, 100, 100000],
+        },
+      };
+
       const exporter = new OTLPMetricExporter({
         aggregationPreference: _instrumentType => aggregation,
       });
@@ -239,11 +243,15 @@ describe('OTLPMetricExporter - node with json over http', () => {
 
     it('aggregationSelector returns the default aggregation preference when nothing is supplied', () => {
       const exporter = new OTLPMetricExporter({
-        aggregationPreference: _instrumentType => Aggregation.Default(),
+        aggregationPreference: _instrumentType => {
+          return { type: AggregationType.DEFAULT };
+        },
       });
-      assert.equal(
+      assert.deepStrictEqual(
         exporter.selectAggregation(InstrumentType.COUNTER),
-        Aggregation.Default()
+        {
+          type: AggregationType.DEFAULT,
+        }
       );
     });
   });

experimental/packages/opentelemetry-exporter-metrics-otlp-proto/test/metricsHelper.ts

@@ -25,10 +25,9 @@ import {
 import { Resource } from '@opentelemetry/resources';
 import * as assert from 'assert';
 import {
-  ExplicitBucketHistogramAggregation,
+  AggregationType,
   MeterProvider,
   MetricReader,
-  View,
 } from '@opentelemetry/sdk-metrics';
 import {
   encodeAsString,
@@ -71,10 +70,13 @@ export function setUp() {
   meterProvider = new MeterProvider({
     resource: testResource,
     views: [
-      new View({
-        aggregation: new ExplicitBucketHistogramAggregation([0, 100]),
+      {
+        aggregation: {
+          type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+          options: { boundaries: [0, 100] },
+        },
         instrumentName: 'int-histogram',
-      }),
+      },
     ],
     readers: [reader],
   });

experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts

@@ -17,8 +17,8 @@
 import { diag } from '@opentelemetry/api';
 import { globalErrorHandler } from '@opentelemetry/core';
 import {
-  Aggregation,
   AggregationTemporality,
+  AggregationType,
   MetricReader,
 } from '@opentelemetry/sdk-metrics';
 import { createServer, IncomingMessage, Server, ServerResponse } from 'http';
@@ -60,7 +60,11 @@ export class PrometheusExporter extends MetricReader {
     callback: (error: Error | void) => void = () => {}
   ) {
     super({
-      aggregationSelector: _instrumentType => Aggregation.Default(),
+      aggregationSelector: _instrumentType => {
+        return {
+          type: AggregationType.DEFAULT,
+        };
+      },
       aggregationTemporalitySelector: _instrumentType =>
         AggregationTemporality.CUMULATIVE,
       metricProducers: config.metricProducers,

experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusSerializer.test.ts

@@ -17,17 +17,12 @@
 import * as assert from 'assert';
 import { Attributes, UpDownCounter } from '@opentelemetry/api';
 import {
-  Aggregation,
   AggregationTemporality,
   DataPoint,
   DataPointType,
-  ExplicitBucketHistogramAggregation,
   Histogram,
-  LastValueAggregation,
   MeterProvider,
   MetricReader,
-  SumAggregation,
-  View,
 } from '@opentelemetry/sdk-metrics';
 import * as sinon from 'sinon';
 import { PrometheusSerializer } from '../src';
@@ -40,6 +35,7 @@ import {
   serviceName,
 } from './util';
 import { Resource } from '@opentelemetry/resources';
+import { AggregationType } from '@opentelemetry/sdk-metrics';
 
 const attributes = {
   foo1: 'bar1',
@@ -56,7 +52,9 @@ class TestMetricReader extends MetricReader {
     super({
       aggregationTemporalitySelector: _instrumentType =>
         AggregationTemporality.CUMULATIVE,
-      aggregationSelector: _instrumentType => Aggregation.Default(),
+      aggregationSelector: _instrumentType => {
+        return { type: AggregationType.DEFAULT };
+      },
     });
   }
 
@@ -86,10 +84,10 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new SumAggregation(),
+            {
+              aggregation: { type: AggregationType.SUM },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -136,10 +134,15 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new ExplicitBucketHistogramAggregation([1, 10, 100]),
+            {
+              aggregation: {
+                type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+                options: {
+                  boundaries: [1, 10, 100],
+                },
+              },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -201,10 +204,10 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new SumAggregation(),
+            {
+              aggregation: { type: AggregationType.SUM },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -256,10 +259,10 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new SumAggregation(),
+            {
+              aggregation: { type: AggregationType.SUM },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -310,10 +313,12 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new LastValueAggregation(),
+            {
+              aggregation: {
+                type: AggregationType.LAST_VALUE,
+              },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -364,10 +369,13 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new ExplicitBucketHistogramAggregation([1, 10, 100]),
+            {
+              aggregation: {
+                type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+                options: { boundaries: [1, 10, 100] },
+              },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -419,10 +427,13 @@ describe('PrometheusSerializer', () => {
         const reader = new TestMetricReader();
         const meterProvider = new MeterProvider({
           views: [
-            new View({
-              aggregation: new ExplicitBucketHistogramAggregation([1, 10, 100]),
+            {
+              aggregation: {
+                type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
+                options: { boundaries: [1, 10, 100] },
+              },
               instrumentName: '*',
-            }),
+            },
           ],
           readers: [reader],
         });
@@ -472,7 +483,10 @@ describe('PrometheusSerializer', () => {
       const reader = new TestMetricReader();
       const meterProvider = new MeterProvider({
         views: [
-          new View({ aggregation: new SumAggregation(), instrumentName: '*' }),
+          {
+            aggregation: { type: AggregationType.SUM },
+            instrumentName: '*',
+          },
         ],
         readers: [reader],
       });
@@ -561,7 +575,10 @@ describe('PrometheusSerializer', () => {
       const reader = new TestMetricReader();
       const meterProvider = new MeterProvider({
         views: [
-          new View({ aggregation: new SumAggregation(), instrumentName: '*' }),
+          {
+            aggregation: { type: AggregationType.SUM },
+            instrumentName: '*',
+          },
         ],
         readers: [reader],
       });