feat(sdk-metrics-base): async instruments callback timeout (#2742)

Co-authored-by: Daniel Dyla <[email protected]>

Author: legendecas

experimental/CHANGELOG.md

@@ -13,6 +13,7 @@ All notable changes to experimental packages in this project will be documented
 
 * feat(exporters): update proto version and use otlp-transformer #2929 @pichlermarc
 * fix(sdk-metrics-base): misbehaving aggregation temporality selector tolerance #2958 @legendecas
+* feat(sdk-metrics-base): async instruments callback timeout #2742 @legendecas
 
 ### :bug: (Bug Fix)
 

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

@@ -144,7 +144,9 @@ const testOTLPMetricExporter = (params: TestParams) =>
       histogram.record(7);
       histogram.record(14);
 
-      metrics = await collect();
+      const { resourceMetrics, errors } = await collect();
+      assert.strictEqual(errors.length, 0);
+      metrics = resourceMetrics;
     });
 
     afterEach(async () => {

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

@@ -66,7 +66,9 @@ describe('OTLPMetricExporter - web', () => {
     histogram.record(7);
     histogram.record(14);
 
-    metrics = await collect();
+    const { resourceMetrics, errors } = await collect();
+    assert.strictEqual(errors.length, 0);
+    metrics = resourceMetrics;
 
     // Need to stub/spy on the underlying logger as the "diag" instance is global
     debugStub = sinon.stub();

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

@@ -76,7 +76,9 @@ describe('OTLPMetricExporter - common', () => {
       );
       counter.add(1);
 
-      metrics = await collect();
+      const { resourceMetrics, errors } = await collect();
+      assert.strictEqual(errors.length, 0);
+      metrics = resourceMetrics;
     });
 
     it('should create an instance', () => {

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

@@ -173,7 +173,9 @@ describe('OTLPMetricExporter - node with json over http', () => {
       histogram.record(7);
       histogram.record(14);
 
-      metrics = await collect();
+      const { resourceMetrics, errors } = await collect();
+      assert.strictEqual(errors.length, 0);
+      metrics = resourceMetrics;
     });
 
     it('should open the connection', done => {

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

@@ -125,7 +125,9 @@ describe('OTLPMetricExporter - node with proto over http', () => {
       histogram.record(7);
       histogram.record(14);
 
-      metrics = await collect();
+      const { resourceMetrics, errors } = await collect();
+      assert.strictEqual(errors.length, 0);
+      metrics = resourceMetrics;
     });
 
     afterEach(async () => {

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

@@ -191,11 +191,12 @@ export class PrometheusExporter extends MetricReader {
     response.setHeader('content-type', 'text/plain');
     this.collect()
       .then(
-        resourceMetrics => {
-          let result = NO_REGISTERED_METRICS;
-          if (resourceMetrics != null) {
-            result = this._serializer.serialize(resourceMetrics);
+        collectionResult => {
+          const { resourceMetrics, errors } = collectionResult;
+          if (errors.length) {
+            diag.error('PrometheusExporter: metrics collection errors', ...errors);
           }
+          let result = this._serializer.serialize(resourceMetrics);
           if (result === '') {
             result = NO_REGISTERED_METRICS;
           }

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

@@ -77,8 +77,8 @@ describe('PrometheusSerializer', () => {
         const counter = meter.createCounter('test_total');
         counter.add(1, attributes);
 
-        const resourceMetrics = await reader.collect();
-        assert(resourceMetrics != null);
+        const { resourceMetrics, errors } = await reader.collect();
+        assert.strictEqual(errors.length, 0);
         assert.strictEqual(resourceMetrics.scopeMetrics.length, 1);
         assert.strictEqual(resourceMetrics.scopeMetrics[0].metrics.length, 1);
         const metric = resourceMetrics.scopeMetrics[0].metrics[0];
@@ -120,8 +120,8 @@ describe('PrometheusSerializer', () => {
         const histogram = meter.createHistogram('test');
         histogram.record(5, attributes);
 
-        const resourceMetrics = await reader.collect();
-        assert(resourceMetrics != null);
+        const { resourceMetrics, errors } = await reader.collect();
+        assert.strictEqual(errors.length, 0);
         assert.strictEqual(resourceMetrics.scopeMetrics.length, 1);
         assert.strictEqual(resourceMetrics.scopeMetrics[0].metrics.length, 1);
         const metric = resourceMetrics.scopeMetrics[0].metrics[0];
@@ -178,8 +178,8 @@ describe('PrometheusSerializer', () => {
         counter.add(1, { val: '1' });
         counter.add(1, { val: '2' });
 
-        const resourceMetrics = await reader.collect();
-        assert(resourceMetrics != null);
+        const { resourceMetrics, errors } = await reader.collect();
+        assert.strictEqual(errors.length, 0);
         assert.strictEqual(resourceMetrics.scopeMetrics.length, 1);
         assert.strictEqual(resourceMetrics.scopeMetrics[0].metrics.length, 1);
         const scopeMetrics = resourceMetrics.scopeMetrics[0];
@@ -230,8 +230,8 @@ describe('PrometheusSerializer', () => {
 
         histogram.record(5, { val: '2' });
 
-        const resourceMetrics = await reader.collect();
-        assert(resourceMetrics != null);
+        const { resourceMetrics, errors } = await reader.collect();
+        assert.strictEqual(errors.length, 0);
         assert.strictEqual(resourceMetrics.scopeMetrics.length, 1);
         assert.strictEqual(resourceMetrics.scopeMetrics[0].metrics.length, 1);
         const scopeMetrics = resourceMetrics.scopeMetrics[0];
@@ -275,8 +275,8 @@ describe('PrometheusSerializer', () => {
       const counter = meter.createCounter(name);
       counter.add(1);
 
-      const resourceMetrics = await reader.collect();
-      assert(resourceMetrics != null);
+      const { resourceMetrics, errors } = await reader.collect();
+      assert.strictEqual(errors.length, 0);
       assert.strictEqual(resourceMetrics.scopeMetrics.length, 1);
       assert.strictEqual(resourceMetrics.scopeMetrics[0].metrics.length, 1);
       const metric = resourceMetrics.scopeMetrics[0].metrics[0];
@@ -314,8 +314,8 @@ describe('PrometheusSerializer', () => {
       const counter = meter.createUpDownCounter(name);
       fn(counter);
 
-      const resourceMetrics = await reader.collect();
-      assert(resourceMetrics != null);
+      const { resourceMetrics, errors } = await reader.collect();
+      assert.strictEqual(errors.length, 0);
       assert.strictEqual(resourceMetrics.scopeMetrics.length, 1);
       assert.strictEqual(resourceMetrics.scopeMetrics[0].metrics.length, 1);
       const metric = resourceMetrics.scopeMetrics[0].metrics[0];

experimental/packages/opentelemetry-sdk-metrics-base/src/export/MetricData.ts

@@ -66,6 +66,11 @@ export interface ResourceMetrics {
   scopeMetrics: ScopeMetrics[];
 }
 
+export interface CollectionResult {
+  resourceMetrics: ResourceMetrics;
+  errors: unknown[];
+}
+
 /**
  * The aggregated point data type.
  */

experimental/packages/opentelemetry-sdk-metrics-base/src/export/MetricProducer.ts

@@ -14,11 +14,15 @@
  * limitations under the License.
  */
 
-import { ResourceMetrics } from './MetricData';
+import { CollectionResult } from './MetricData';
+
+export interface MetricCollectOptions {
+  timeoutMillis?: number;
+}
 
 /**
  * This is a public interface that represent an export state of a MetricReader.
  */
 export interface MetricProducer {
-  collect(): Promise<ResourceMetrics>;
+  collect(options?: MetricCollectOptions): Promise<CollectionResult>;
 }