Update setMetricProducer doc string to mark it internal

open-telemetry · Aug 9, 2023 · f095627 · f095627
1 parent 15c1d39
commit f095627
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/packages/sdk-metrics/src/export/MetricReader.ts b/packages/sdk-metrics/src/export/MetricReader.ts
@@ -79,8 +79,13 @@ export abstract class MetricReader {
   }
 
   /**
-   * Set the {@link MetricProducer} used by this instance.
+   * Set the {@link MetricProducer} used by this instance. **This should only be called by the
+   * SDK and should be considered internal.**
    *
+   * To add additional {@link MetricProducer}s to a {@link MetricReader}, pass them to the
+   * constructor as {@link MetricReaderOptions.metricProducers}.
+   *
+   * @internal
    * @param metricProducer
    */
   setMetricProducer(metricProducer: MetricProducer) {