Skip to content

Commit

Permalink
describe the produce function
Browse files Browse the repository at this point in the history
  • Loading branch information
dashpole committed Aug 17, 2022
1 parent 5578fd5 commit b854506
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -1123,15 +1123,16 @@ A `MetricProducer` MUST support the following functions:

#### Produce() batch

`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).

`Produce` SHOULD provide a way to let the caller know whether it succeeded,
failed or timed out. When the `Produce` operation fails, the `MetricProducer`
MAY return successfully collected results and a failed reasons list to the
caller.

`Produce` does not have any required parameters, however, [OpenTelemetry
SDK](../overview.md#sdk) authors MAY choose to add parameters (e.g. timeout).
`Produce` MUST return a batch of [Metric points](./data-model.md#metric-points).

## Defaults and configuration

The SDK MUST provide configuration according to the [SDK environment
Expand Down

0 comments on commit b854506

Please sign in to comment.