-
Notifications
You must be signed in to change notification settings - Fork 911
Define what constitutes breaking changes for Metrics #2864
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
Comments
We'd like to tackle this question by focusing on what use cases for metrics should be preserved between OTEL instrumentation releases and expected interactions with For the first cut, we should investigate breaking behavior of:
|
Does this plan to change the semantic convention stability guidelines? |
Yes. Specifically I want us to answer whether:
|
Here's an unfinished document that walks through the problem of stability and how I'd like to think about it. I only had time to discuss Alerting instability of metrics, specifically when is it ok to add new attributes to a metric timeseries. Welcome people's thoughts and opinions and more scenarios to tackle in that document as we go forward. |
Updated a section for Metrics for our next meeting, including three topic points:
I have my thoughts on each, but want to discuss in the WG. |
From WG + Spec SiG:
We don't enforce this in the specification today, and doing so is likely breaking or lots of churn/work. We'd like to nuance what is considered breaking to something akin to:
|
…by semconv that can be included in stability.
Fixes #2864 Fixes #2883 ## Changes - Explicitly define what is "enforced" by stability guarantees from Semantic conventions. - We enforce attribute key names + types, across resource, span, metric and log - We enforce span names - We enforce metric names, units - Expand allowed changes to semconv to include metric attributes that do not increase timeseries count for a given metric. ## Context Sig discussion thread/doc [here](https://docs.google.com/document/d/1Nvcf1wio7nDUVcrXxVUN_f8MNmcs0OzVAZLvlth1lYY/edit?usp=sharing). --------- Co-authored-by: Trask Stalnaker <[email protected]> Co-authored-by: Johannes Tax <[email protected]> Co-authored-by: Tigran Najaryan <[email protected]> Co-authored-by: Patrice Chalin <[email protected]> Co-authored-by: Sergey Kanzhelev <[email protected]> Co-authored-by: Carlos Alberto Cortez <[email protected]> Co-authored-by: Tyler Benson <[email protected]> Co-authored-by: Joshua Carpeggiani <[email protected]> Co-authored-by: Armin Ruech <[email protected]> Co-authored-by: Yuri Shkuro <[email protected]> Co-authored-by: Asaf Mesika <[email protected]> Co-authored-by: Evan Mattson <[email protected]> Co-authored-by: jack-berg <[email protected]> Co-authored-by: Antoine Toulme <[email protected]> Co-authored-by: Christian Neumüller <[email protected]> Co-authored-by: Liudmila Molkova <[email protected]> Co-authored-by: Reiley Yang <[email protected]> Co-authored-by: Joshua MacDonald <[email protected]>
…try#3225) Fixes open-telemetry#2864 Fixes open-telemetry#2883 ## Changes - Explicitly define what is "enforced" by stability guarantees from Semantic conventions. - We enforce attribute key names + types, across resource, span, metric and log - We enforce span names - We enforce metric names, units - Expand allowed changes to semconv to include metric attributes that do not increase timeseries count for a given metric. ## Context Sig discussion thread/doc [here](https://docs.google.com/document/d/1Nvcf1wio7nDUVcrXxVUN_f8MNmcs0OzVAZLvlth1lYY/edit?usp=sharing). --------- Co-authored-by: Trask Stalnaker <[email protected]> Co-authored-by: Johannes Tax <[email protected]> Co-authored-by: Tigran Najaryan <[email protected]> Co-authored-by: Patrice Chalin <[email protected]> Co-authored-by: Sergey Kanzhelev <[email protected]> Co-authored-by: Carlos Alberto Cortez <[email protected]> Co-authored-by: Tyler Benson <[email protected]> Co-authored-by: Joshua Carpeggiani <[email protected]> Co-authored-by: Armin Ruech <[email protected]> Co-authored-by: Yuri Shkuro <[email protected]> Co-authored-by: Asaf Mesika <[email protected]> Co-authored-by: Evan Mattson <[email protected]> Co-authored-by: jack-berg <[email protected]> Co-authored-by: Antoine Toulme <[email protected]> Co-authored-by: Christian Neumüller <[email protected]> Co-authored-by: Liudmila Molkova <[email protected]> Co-authored-by: Reiley Yang <[email protected]> Co-authored-by: Joshua MacDonald <[email protected]>
We should outline what changes to metric streams (names, unit, type + attributes) constitutes a breaking change.
More details to follow
The text was updated successfully, but these errors were encountered: