clarify parameters of the MetricProducer.Produce()

open-telemetry · Jul 14, 2023 · 69a5f78 · 69a5f78
1 parent d54a51b
commit 69a5f78
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,7 @@ release.
 
 ### Metrics
 
-- Promote MetricProducer and MetricReader.RegisterProducer specification to feature-freeze.
+- Promote MetricProducer and MetricReader.RegisterProducer specification to feature-freeze, and clarify Produce() parameters.
   ([#3600](https://github.com/open-telemetry/opentelemetry-specification/pull/3600))
 
 ### Logs

diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md
@@ -1422,7 +1422,8 @@ A `MetricProducer` MUST support the following functions:
 `Produce` provides metrics from the MetricProducer to the caller. `Produce`
 MUST return a batch of [Metric points](./data-model.md#metric-points).
 `Produce` does not have any required parameters, however, [OpenTelemetry
-SDK](../overview.md#sdk) authors MAY choose to add parameters (e.g. timeout).
+SDK](../overview.md#sdk) authors MAY choose to add required or optional
+parameters (e.g. timeout).
 
 `Produce` SHOULD provide a way to let the caller know whether it succeeded,
 failed or timed out. When the `Produce` operation fails, the `MetricProducer`