-
Notifications
You must be signed in to change notification settings - Fork 888
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.
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
Mark Metrics SDK as Mixed/Stable #2150
Closed
Closed
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
2ed0469
Mark Metrics SDK as Stable
reyang d402f47
Merge branch 'main' into reyang/metrics-sdk-stable
reyang 6539080
update changelog
reyang 165f9b7
Merge branch 'main' into reyang/metrics-sdk-stable
reyang 09b82d5
Merge branch 'main' into reyang/metrics-sdk-stable
reyang 11e1e4d
change the doc status to Mixed
reyang 68952d1
update changelog
reyang b82e2a7
mark exemplar and baggage as experimental
reyang 1d47e9a
Merge branch 'main' into reyang/metrics-sdk-stable
reyang 3cbae8a
update the status based on discussion in the spec SIG
reyang f838e4a
Merge branch 'main' into reyang/metrics-sdk-stable
reyang fcd97b8
rewrap
reyang 4da897e
Merge branch 'main' into reyang/metrics-sdk-stable
jmacd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,6 +1,6 @@ | ||||||
# Metrics SDK | ||||||
|
||||||
**Status**: [Feature-freeze](../document-status.md) | ||||||
**Status**: [Mixed](../document-status.md) | ||||||
|
||||||
<details> | ||||||
<summary>Table of Contents</summary> | ||||||
|
@@ -47,6 +47,8 @@ | |||||
|
||||||
## MeterProvider | ||||||
|
||||||
**Status**: [Stable](../document-status.md) | ||||||
|
||||||
A `MeterProvider` MUST provide a way to allow a [Resource](../resource/sdk.md) to | ||||||
be specified. If a `Resource` is specified, it SHOULD be associated with all the | ||||||
metrics produced by any `Meter` from the `MeterProvider`. The [tracing SDK | ||||||
|
@@ -180,17 +182,19 @@ are the inputs: | |||||
not in the list will be ignored. If not provided, all the attribute keys | ||||||
will be used by default (TODO: once the Hint API is available, the default | ||||||
behavior should respect the Hint if it is available). | ||||||
* The `extra dimensions` which come from Baggage/Context (optional). If not | ||||||
provided, no extra dimension will be used. Please note that this only | ||||||
applies to [synchronous Instruments](./api.md#synchronous-instrument). | ||||||
* **Status**: [Experimental](../document-status.md) - the `extra dimensions` | ||||||
reyang marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
which come from Baggage/Context (optional). If not provided, no extra | ||||||
dimension will be used. Please note that this only applies to [synchronous | ||||||
Instruments](./api.md#synchronous-instrument). | ||||||
* The `aggregation` (optional) to be used. If not provided, the SDK MUST | ||||||
apply a [default aggregation](#default-aggregation). If the aggregation | ||||||
outputs metric points that use aggregation temporality (e.g. Histogram, | ||||||
Sum), the SDK SHOULD handle the aggregation temporality based on the | ||||||
temporality of each [MetricReader](#metricreader) instance. | ||||||
* The `exemplar_reservoir` (optional) to use for storing exemplars. | ||||||
This should be a factory or callback similar to aggregation which allows | ||||||
different reservoirs to be chosen by the aggregation. | ||||||
* **Status**: [Experimental](../document-status.md) - the `exemplar_reservoir` | ||||||
(optional) to use for storing exemplars. This should be a factory or | ||||||
callback similar to aggregation which allows different reservoirs to be | ||||||
chosen by the aggregation. | ||||||
|
||||||
The SDK SHOULD use the following logic to determine how to process Measurements | ||||||
made with an Instrument: | ||||||
|
@@ -422,13 +426,17 @@ This Aggregation informs the SDK to collect: | |||||
|
||||||
## Attribute limits | ||||||
|
||||||
**Status**: [Stable](../document-status.md) | ||||||
|
||||||
Attributes which belong to Metrics are exempt from the | ||||||
[common rules of attribute limits](../common/common.md#attribute-limits) at this | ||||||
time. Attribute truncation or deletion could affect identitity of metric time | ||||||
series and it requires further analysis. | ||||||
|
||||||
## Exemplar | ||||||
|
||||||
**Status**: [Experimental](../document-status.md) | ||||||
|
||||||
An [Exemplar](./datamodel.md#exemplars) is a recorded | ||||||
[Measurement](./api.md#measurement) that exposes the following pieces of | ||||||
information: | ||||||
|
@@ -554,6 +562,8 @@ measurements using the equivalent of the following naive algorithm: | |||||
|
||||||
## MetricReader | ||||||
|
||||||
**Status**: [Stable](../document-status.md) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`MetricReader` is an interface which provides the following capabilities: | ||||||
|
||||||
* Collecting metrics from the SDK. | ||||||
|
@@ -657,6 +667,8 @@ Configurable parameters: | |||||
|
||||||
## MetricExporter | ||||||
|
||||||
**Status**: [Stable](../document-status.md) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`MetricExporter` defines the interface that protocol-specific exporters MUST | ||||||
implement so that they can be plugged into OpenTelemetry SDK and support sending | ||||||
of telemetry data. | ||||||
|
@@ -876,6 +888,8 @@ errors/exceptions are taken care of. | |||||
|
||||||
## Compatibility requirements | ||||||
|
||||||
**Status**: [Stable](../document-status.md) | ||||||
|
||||||
All the metrics components SHOULD allow new methods to be added to existing | ||||||
components without introducing breaking changes. | ||||||
|
||||||
|
@@ -884,6 +898,8 @@ existing methods without introducing breaking changes, if possible. | |||||
|
||||||
## Concurrency requirements | ||||||
|
||||||
**Status**: [Stable](../document-status.md) | ||||||
|
||||||
For languages which support concurrent execution the Metrics SDKs provide | ||||||
specific guarantees and safeties. | ||||||
|
||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.