Mark Metrics SDK as Mixed/Stable #2150

reyang · 2021-11-23T06:19:26Z

This moves the Metrics SDK specification to Mixed/Stable:

Once the spec is marked as "Stable", breaking changes are no longer allowed.
Additive changes are allowed.

These are the issues that should be resolved before we could merge this PR, unless the issue is specific about things that are not marked as Stable in this PR (e.g. Exemplar):
https://github.com/open-telemetry/opentelemetry-specification/issues?q=is%3Aissue+is%3Aopen+label%3Aspec%3Ametrics+label%3Aarea%3Asdk+label%3Arelease%3Arequired-for-ga+-label%3Aarea%3Asemantic-conventions+

Project board https://github.com/orgs/open-telemetry/projects/9.

_{(original link)}

MrAlias

I am not able to approve this as the Go implementation is still being built.

tigrannajaryan · 2021-11-23T23:41:04Z

I am not able to approve this as the Go implementation is still being built.

I believe this change says the SDK spec is stable. It does not mean that the SDK implementations are stable.

MrAlias · 2021-11-24T00:13:30Z

I am not able to approve this as the Go implementation is still being built.

I believe this change says the SDK spec is stable. It does not mean that the SDK implementations are stable.

Right, sorry, I wasn't clear. Without an implementation it is hard to say if this specification should be marked stable, specifically from the Go SIGs perspective. There are possibilities that parts of the specification are not implementable in the Go implementation. If that is the case there may need to be modifications that would not be compliant with our stability guarantee.

carlosalberto · 2021-11-24T02:02:42Z

@jmacd you have been prototyping something for Go, right?

anuraaga · 2021-11-24T02:54:34Z

There are a couple of TODOs in sdk.md they make the file "feel" not stable - perhaps they should be moved to issues and removed?

reyang · 2021-11-24T05:37:57Z

There are a couple of TODOs in sdk.md they make the file "feel" not stable - perhaps they should be moved to issues and removed?

There are two places where we have TODOs, and both of them are post-Stable topics (and have issues tracking them).

It seems to be an okay practice? - we've discussed this in the previous Metrics SIG meeting and actually confirmed that the Stable tracing spec also has TODOs.

I'm fine with removing these TODOs if most folks think it'll help to create more clarity.

reyang · 2021-11-24T05:50:01Z

I am not able to approve this as the Go implementation is still being built.

I believe this change says the SDK spec is stable. It does not mean that the SDK implementations are stable.

Right, sorry, I wasn't clear. Without an implementation it is hard to say if this specification should be marked stable, specifically from the Go SIGs perspective. There are possibilities that parts of the specification are not implementable in the Go implementation. If that is the case there may need to be modifications that would not be compliant with our stability guarantee.

We've discussed this in the previous Spec SIG meeting (several weeks before we marked the Metrics API spec as Stable). In order to mark the Metrics SDK spec as Stable, the following things are required:

All the issues that are tagged as area:sdk + spec:metrics + release:required-for-ga are resolved.
The Metrics SIG has a good confidence that the spec won't have breaking changes.
There are multiple (e.g. 3) language SIGs which are able to follow the spec and implement the metrics SDK.

These are non-goal for Stable:

All languages SIGs could finish the implementation.
All the clarification questions are answered. Many of them are nice-to-have and can be post Stable (e.g. area:allowed-for-ga or area:after-ga or editorial).

specification/metrics/sdk.md

cijothomas

LGTM.

cijothomas · 2021-11-29T19:26:49Z

The data model and proto are stable already, so can we also mark the exporters , except Prometheus, (i.e OTLP , stdout, inmemory) as stable as well? (separate topic, but related, hence mentioning it here.)

reyang · 2021-11-29T19:42:34Z

The data model and proto are stable already, so can we also mark the exporters , except Prometheus, (i.e OTLP , stdout, inmemory) as stable as well? (separate topic, but related, hence mentioning it here.)

#2175

carlosalberto · 2021-11-30T00:28:51Z

Sounds like a good trade off going forward!

jmacd

I propose several components remain in Feature-freeze. This topic was discussed by the technical committee today and the consensus is that we believe the specification is practically Stable, but that an uninitiated member of the community could probably not implement it from scratch in a way that conforms with our group understanding.

We expect to do a bit of editorial work on this specification as the next 1 or 2 prototypes are completed, and then we can finish marking this Stable.

jmacd · 2021-12-01T17:52:10Z

specification/metrics/sdk.md

@@ -47,6 +47,8 @@

 ## MeterProvider

+**Status**: [Stable](../document-status.md)


Suggested change

**Status**: [Stable](../document-status.md)

**Status**: [Feature-freeze](../document-status.md)

jmacd · 2021-12-01T17:52:34Z

specification/metrics/sdk.md

@@ -554,6 +562,8 @@ measurements using the equivalent of the following naive algorithm:

 ## MetricReader

+**Status**: [Stable](../document-status.md)


Suggested change

**Status**: [Stable](../document-status.md)

**Status**: [Feature-freeze](../document-status.md)

jmacd · 2021-12-01T17:52:50Z

specification/metrics/sdk.md

@@ -661,6 +671,8 @@ Configurable parameters:

 ## MetricExporter

+**Status**: [Stable](../document-status.md)


Suggested change

**Status**: [Stable](../document-status.md)

**Status**: [Feature-freeze](../document-status.md)

jmacd

@open-telemetry/technical-committee as discussed I think we can merge this PR after accepting the three changes proposed by me.

jmacd · 2021-12-01T17:57:05Z

@cijothomas please take a look at my proposal for merging this PR.

cijothomas · 2021-12-01T18:08:41Z

@cijothomas please take a look at my proposal for merging this PR.

This comment was calling out that, the Exporter section of the SDK spec is not stable, so the exporters themselves (OTLP/Stdout/InMemory), should not be marked stable.

jmacd · 2021-12-01T18:36:47Z

Exporter section of the SDK spec is not stable, so the exporters themselves (OTLP/Stdout/InMemory), should not be marked stable.

I'm not sure I agree -- can't a specific exporter specification be stable even if the general interface specification is not? For components of an SDK I see this dependency being real (i.e., an SDK exporter can't be stable of other components it depends on are not stable), but for a specification I don't see a hard connection there.

E.g., the stderr exporter says the "StderrExporter is an Exporter". This is true and stable and will not change even if we change the specification for Exporter, right?

jmacd

With the suggestion to leave MeterProvider in Feature-freeze, these two sections are redundant.

jmacd · 2021-12-01T18:43:12Z

specification/metrics/sdk.md

-  * 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**: [Feature-freeze](../document-status.md) - the `extra dimensions`


Suggested change

* **Status**: [Feature-freeze](../document-status.md) - the `extra dimensions`

* the `extra dimensions`

jmacd · 2021-12-01T18:43:27Z

specification/metrics/sdk.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.
+  * **Status**: [Feature-freeze](../document-status.md) - the


Suggested change

* **Status**: [Feature-freeze](../document-status.md) - the

* the

github-actions · 2021-12-09T03:17:13Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2021-12-17T03:17:09Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

reyang added 3 commits November 22, 2021 22:15

Mark Metrics SDK as Stable

2ed0469

Merge branch 'main' into reyang/metrics-sdk-stable

d402f47

update changelog

6539080

reyang marked this pull request as ready for review November 23, 2021 06:21

reyang requested review from a team November 23, 2021 06:21

reyang added spec:metrics Related to the specification/metrics directory area:sdk Related to the SDK labels Nov 23, 2021

github-actions bot assigned yurishkuro Nov 23, 2021

reyang added the release:required-for-ga Must be resolved before GA release, or nice to have before GA label Nov 23, 2021

reyang added this to the Metrics API/SDK Stable Release milestone Nov 23, 2021

MrAlias reviewed Nov 23, 2021

View reviewed changes

anuraaga mentioned this pull request Nov 24, 2021

Remove baggage handling from metrics SDK for now #2160

Closed

reyang added 3 commits November 23, 2021 21:50

Merge branch 'main' into reyang/metrics-sdk-stable

165f9b7

Merge branch 'main' into reyang/metrics-sdk-stable

09b82d5

change the doc status to Mixed

11e1e4d

reyang changed the title ~~Mark Metrics SDK as Stable~~ Mark Metrics SDK as Mixed/Stable Nov 29, 2021

reyang added 2 commits November 29, 2021 09:48

update changelog

68952d1

mark exemplar and baggage as experimental

b82e2a7

reyang commented Nov 29, 2021

View reviewed changes

specification/metrics/sdk.md Outdated Show resolved Hide resolved

Merge branch 'main' into reyang/metrics-sdk-stable

1d47e9a

cijothomas approved these changes Nov 29, 2021

View reviewed changes

reyang mentioned this pull request Nov 29, 2021

Mark In-Memory/OTLP/Stdout exporters as Stable #2175

Merged

carlosalberto approved these changes Nov 30, 2021

View reviewed changes

anuraaga approved these changes Nov 30, 2021

View reviewed changes

reyang added 3 commits November 30, 2021 09:01

update the status based on discussion in the spec SIG

3cbae8a

Merge branch 'main' into reyang/metrics-sdk-stable

f838e4a

rewrap

fcd97b8

jack-berg approved these changes Dec 1, 2021

View reviewed changes

jmacd approved these changes Dec 1, 2021

View reviewed changes

jmacd requested changes Dec 1, 2021

View reviewed changes

Merge branch 'main' into reyang/metrics-sdk-stable

4da897e

jmacd requested changes Dec 1, 2021

View reviewed changes

github-actions bot added the Stale label Dec 9, 2021

tomkerkhove mentioned this pull request Dec 16, 2021

Standardize traffic metrics across traffic sources kedacore/http-add-on#354

Open

github-actions bot closed this Dec 17, 2021

reyang mentioned this pull request Jan 31, 2022

Move metrics SDK spec to Mixed #2304

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mark Metrics SDK as Mixed/Stable #2150

Mark Metrics SDK as Mixed/Stable #2150

reyang commented Nov 23, 2021 •

edited

Loading

MrAlias left a comment

tigrannajaryan commented Nov 23, 2021

MrAlias commented Nov 24, 2021

carlosalberto commented Nov 24, 2021

anuraaga commented Nov 24, 2021

reyang commented Nov 24, 2021 •

edited

Loading

reyang commented Nov 24, 2021 •

edited

Loading

cijothomas left a comment

cijothomas commented Nov 29, 2021

reyang commented Nov 29, 2021

carlosalberto commented Nov 30, 2021

jmacd left a comment

jmacd Dec 1, 2021

jmacd Dec 1, 2021

jmacd Dec 1, 2021

jmacd left a comment

jmacd commented Dec 1, 2021

cijothomas commented Dec 1, 2021

jmacd commented Dec 1, 2021

jmacd left a comment

jmacd Dec 1, 2021

jmacd Dec 1, 2021

github-actions bot commented Dec 9, 2021

github-actions bot commented Dec 17, 2021

		@@ -47,6 +47,8 @@

		## MeterProvider

		Status: [Stable](../document-status.md)

	Status: [Stable](../document-status.md)
	Status: [Feature-freeze](../document-status.md)

		@@ -554,6 +562,8 @@ measurements using the equivalent of the following naive algorithm:

		## MetricReader

		Status: [Stable](../document-status.md)

		@@ -661,6 +671,8 @@ Configurable parameters:

		## MetricExporter

		Status: [Stable](../document-status.md)

	* Status: [Feature-freeze](../document-status.md) - the `extra dimensions`
	* the `extra dimensions`

	* Status: [Feature-freeze](../document-status.md) - the
	* the

Mark Metrics SDK as Mixed/Stable #2150

Mark Metrics SDK as Mixed/Stable #2150

Conversation

reyang commented Nov 23, 2021 • edited Loading

MrAlias left a comment

Choose a reason for hiding this comment

tigrannajaryan commented Nov 23, 2021

MrAlias commented Nov 24, 2021

carlosalberto commented Nov 24, 2021

anuraaga commented Nov 24, 2021

reyang commented Nov 24, 2021 • edited Loading

reyang commented Nov 24, 2021 • edited Loading

cijothomas left a comment

Choose a reason for hiding this comment

cijothomas commented Nov 29, 2021

reyang commented Nov 29, 2021

carlosalberto commented Nov 30, 2021

jmacd left a comment

Choose a reason for hiding this comment

jmacd Dec 1, 2021

Choose a reason for hiding this comment

jmacd Dec 1, 2021

Choose a reason for hiding this comment

jmacd Dec 1, 2021

Choose a reason for hiding this comment

jmacd left a comment

Choose a reason for hiding this comment

jmacd commented Dec 1, 2021

cijothomas commented Dec 1, 2021

jmacd commented Dec 1, 2021

jmacd left a comment

Choose a reason for hiding this comment

jmacd Dec 1, 2021

Choose a reason for hiding this comment

jmacd Dec 1, 2021

Choose a reason for hiding this comment

github-actions bot commented Dec 9, 2021

github-actions bot commented Dec 17, 2021

reyang commented Nov 23, 2021 •

edited

Loading

reyang commented Nov 24, 2021 •

edited

Loading

reyang commented Nov 24, 2021 •

edited

Loading