Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify MetricReader.Collect result #2495

Merged
merged 5 commits into from
Apr 21, 2022
+5 −1
Merged

Clarify MetricReader.Collect result #2495

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2917dce
Clarify MetricReader.Collect result
legendecas Apr 18, 2022
d6b38b7
fixup!
legendecas Apr 19, 2022
903abef
Merge branch 'main' into metrics-async-timeout
reyang Apr 19, 2022
a0fcfa7
Update specification/metrics/sdk.md
legendecas Apr 20, 2022
ec5735e
Merge branch 'main' into metrics-async-timeout
reyang Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ release.

- Clarify SDK behavior when view conflicts are present
([#2462](https://github.com/open-telemetry/opentelemetry-specification/pull/2462)).
- Clarify MetricReader.Collect result
([#2495](https://github.com/open-telemetry/opentelemetry-specification/pull/2495)).

### Logs

Expand Down
4 changes: 3 additions & 1 deletion specification/metrics/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,7 +710,9 @@ Instruments](./api.md#asynchronous-instrument-api) involved, their callback
functions will be triggered.

`Collect` SHOULD provide a way to let the caller know whether it succeeded,
failed or timed out.
failed or timed out. When the `Collect` operation fails or times out on
part of the instruments, the SDK MAY return successfully collected results
legendecas marked this conversation as resolved.
Show resolved Hide resolved
and a failed reasons list to the caller.
reyang marked this conversation as resolved.
Show resolved Hide resolved

`Collect` does not have any required parameters, however, [OpenTelemetry
SDK](../overview.md#sdk) authors MAY choose to add parameters (e.g. callback,
Expand Down