-
Notifications
You must be signed in to change notification settings - Fork 660
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
Exclude attributes without stability from stable semconv part #4391
base: main
Are you sure you want to change the base?
Conversation
Ya it should be fine. We were discussing and getting serious about going to a stable version though 😥 Are other languages special casing this to keep it around and not introduce a breakage? |
I think instances like this make us wary for making semantic convention packages stable (which as @aabmass mentioned above we were thinking of doing since we have stable/incubating namespaces.
If there is a good process for special cases like this to prevent breaking changes it might give us some more confidence to go stable :) |
I understand your concerns. It should not have happened.
It was caught by JS during update, and only a few languages got affected. Java has additional filters that prevented. It hit c++ the worst since semconv are part of stable otel api package - open-telemetry/opentelemetry-cpp#3251
Java goes stable with semantic convention (stable) artifact. We fixed the problem in semconv - stability is now required. And this specific issue should not happen again. From python side, we should review public API more carefully in a stable artifact. Of course small unintentional additions could slip in by mistake. I hope it won't happen again, but if it does, we can still use an escape hatch like this one open-telemetry/opentelemetry-cpp@main...lmolkova:opentelemetry-cpp:workaround-network-interface-name (or what we've done in the past keeping removed attributes hardcoded in jinja templates) So I think if you want to release stable semconv, we should make sure we have public API checks in place and in the worst case, if something extra gets in, we'd have to keep it around. Let me know if you have any thoughts on how we can harden it further. I'll also bring it up in semconv call on Monday. |
See open-telemetry/semantic-conventions#1777
Semconv should not have attributes without stability, but this one slipped in.
We'll fix it in semconv and also enforce it better to prevent this in the future - open-telemetry/semantic-conventions#1781, but let's exclude attributes without stability from the stable part.
Since semconv artifact is at
0.50b0
, I assume it's allowed to have breaking changes?This attribute is not used by anything in OTel python, was introduced in prev version of semconv and I'm suggesting to drop it.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Contrib Repo Change?
Checklist: