-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Instrumenting libraries page in spec states metrics API is not stable and needs to be updated to reflect stable status #2575
Comments
Thanks for noticing and reporting the issue. The "stable" status that you are referring to, is the spec's status for metrics. @cartermp et al. can correct me if I'm wrong, but the status being referred to in "Metrics API is not stable" is the implementation across supported languages: which is about 50% at the moment -- that is 50% of languages have "stable" metrics in contrast to some other status (beta, alpha, experimental or not implemented). So, in a sense, the statement is 50% correct 😅. But I agree that that sentence could be clearer. Maybe what we need is actual content for that section as opposed to just a clarification about status. Folks are quite busy with KubeCon approaching, but I'll let @cartermp @svrnm share their thoughts. |
Yeah this is a problematic paragraph. I think we should just nix it + the section altogether for now. It's really not relevant for most end-users of opentelemetry anyways (the context is a doc about writing instrumentation libraries), and sows confusion on a mixed topic. I'd propose we just remove that section. |
@CharlieTLe - do you want to remove that section, as @cartermp suggested? If not I'll submit a patch. |
@chalin stated that > the status being referred to in "Metrics API is not > stable" is the implementation across supported languages: which is about > 50% at the moment -- that is 50% of languages have "stable" metrics in > contrast to some other status (beta, alpha, experimental or not > implemented). So, in a sense, the statement is 50% correct 😅. and @cartermp suggested that we remove the problematic paragraph and section altogether. See: open-telemetry#2575
Fixed in #2581 |
Visit https://opentelemetry.io/docs/concepts/instrumenting-library/#metrics and you'll read (emphasis mine):
Metrics API is not stable yet and we don’t yet define metrics conventions.
But the section to which "not stable yet" links to has been updated from
Feature-freeze -- https://github.com/open-telemetry/opentelemetry-specification/blob/e30aa7da8f28328adb67b4804c4dcddf4f413c1d/specification/metrics/api.md
to
stable -- open-telemetry/opentelemetry-specification#2104
So the "Metrics API is not stable yet" paragraph needs some editing. Who can tackle this (or let me know how to update it)?
cc: @alolita
The text was updated successfully, but these errors were encountered: