feat: update PeriodicExportingMetricReader and PrometheusExporter to …

…accept optional metric producers
open-telemetry · Aug 18, 2023 · 15690f4 · 15690f4
1 parent b400c2e
commit 15690f4
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts b/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts
@@ -62,6 +62,7 @@ export class PrometheusExporter extends MetricReader {
       aggregationSelector: _instrumentType => Aggregation.Default(),
       aggregationTemporalitySelector: _instrumentType =>
         AggregationTemporality.CUMULATIVE,
+      metricProducers: config.metricProducers,
     });
     this._host =
       config.host ||

diff --git a/experimental/packages/opentelemetry-exporter-prometheus/src/export/types.ts b/experimental/packages/opentelemetry-exporter-prometheus/src/export/types.ts
@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { MetricProducer } from '@opentelemetry/sdk-metrics';
+
 /**
  * Configuration interface for prometheus exporter
  */
@@ -56,4 +58,12 @@ export interface ExporterConfig {
    * @default false
    */
   preventServerStart?: boolean;
+
+  /**
+   * **Note, this option is experimental**. Additional MetricProducers to use as a source of
+   * aggregated metric data in addition to the SDK's metric data. The resource returned by
+   * these MetricProducers is ignored; the SDK's resource will be used instead.
+   * @experimental
+   */
+  metricProducers?: MetricProducer[];
 }
diff --git a/packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts b/packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts
@@ -25,6 +25,7 @@ import { MetricReader } from './MetricReader';
 import { PushMetricExporter } from './MetricExporter';
 import { callWithTimeout, TimeoutError } from '../utils';
 import { diag } from '@opentelemetry/api';
+import { MetricProducer } from './MetricProducer';
 
 export type PeriodicExportingMetricReaderOptions = {
   /**
@@ -40,6 +41,13 @@ export type PeriodicExportingMetricReaderOptions = {
    * Milliseconds for the async observable callback to timeout.
    */
   exportTimeoutMillis?: number;
+  /**
+   * **Note, this option is experimental**. Additional MetricProducers to use as a source of
+   * aggregated metric data in addition to the SDK's metric data. The resource returned by
+   * these MetricProducers is ignored; the SDK's resource will be used instead.
+   * @experimental
+   */
+  metricProducers?: MetricProducer[];
 };
 
 /**
@@ -59,6 +67,7 @@ export class PeriodicExportingMetricReader extends MetricReader {
       ),
       aggregationTemporalitySelector:
         options.exporter.selectAggregationTemporality?.bind(options.exporter),
+      metricProducers: options.metricProducers,
     });
 
     if (