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.

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

Remove the "MUST" wording which requires exemplar to be on-by-default #2414

Merged
merged 3 commits into from
Mar 15, 2022

Conversation

reyang
Copy link
Member

@reyang reyang commented Mar 11, 2022

Fixes #2118, which is considered as a blocking issue for metrics SDK spec stable release.

Changes

We've discussed this during the 3/11/2022 metrics issue triage meeting.

The priority is to ship the stable version of the Metrics SDK spec, however the Exemplar part still has many open questions and there are not sufficient prototype from language SIGs. Here are some decisions we've made in order to move the needles:

  • Instead of being blocked by the Exemplar spec, we will focus on shipping the SDK spec as Mixed, by moving most parts to Stable but leave Exemplar as "Feature-freeze" (PR Move metrics SDK spec to Mixed #2304).
  • Weaken the wording in the Exemplar spec, so it won't cause conflict or introduce breaking change to the spec.

This PR removed the "exemplar must be on by default" wording, and used "should be turned off by default" instead. This gives the spec certain room, so later we can change it to "may be turned on by default" or "should be turned on by default" without having to bump the major version of the spec.

Copy link
Contributor

@jmacd jmacd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve this PR with or without the attached, non-blocking suggestion.

specification/metrics/sdk.md Show resolved Hide resolved
Copy link
Member

@cijothomas cijothomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the explanation/rationale for this change looks reasonable to me.

@reyang reyang added this to In progress in Spec - Metrics API/SDK Stable Release via automation Mar 11, 2022
@reyang reyang added this to the Metrics API/SDK Stable Release milestone Mar 11, 2022
Copy link
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, but I think exemplars are a really important feature we should strive to stabilize and enable by default in the near future. Want to reiterate this question:

I'd still like to understand criteria for marking Exemplar stable. Specifically, what more do we need to see, what issues exist in the current specification.

@reyang reyang merged commit b1ca0b3 into open-telemetry:main Mar 15, 2022
Spec - Metrics API/SDK Stable Release automation moved this from In progress to Done Mar 15, 2022
@reyang reyang deleted the reyang/exemplar branch March 15, 2022 18:05
@jack-berg jack-berg mentioned this pull request Mar 21, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Should Exemplar be enabled by default?
7 participants