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

Asynchronous Instrument API does not follow OTel Specification recommendation on naming #3453

Closed
MrAlias opened this issue Nov 8, 2022 · 1 comment · Fixed by #3575
Closed
Assignees
Labels
area:metrics Part of OpenTelemetry Metrics bug Something isn't working pkg:API Related to an API package

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Nov 8, 2022

The OpenTelemetry specification recommends naming asynchronous instrument with certain names:

Asynchronous Counter creation

It is highly recommended that implementations use the name ObservableCounter (or any language idiomatic variation, e.g. observable_counter) unless there is a strong reason not to do so.

Asynchronous Gauge creation

It is highly recommended that implementations use the name ObservableGauge (or any language idiomatic variation, e.g. observable_gauge) unless there is a strong reason not to do so.

Asynchronous UpDownCounter creation

It is highly recommended that implementations use the name ObservableUpDownCounter (or any language idiomatic variation, e.g. observable_updowncounter) unless there is a strong reason not to do so.

The opentelemetry-go project does not currently adhere to this naming strategy. I do not see a strong reason to not do so either.

@MrAlias
Copy link
Contributor Author

MrAlias commented Dec 8, 2022

I think this may be solved by #3530.

I'm not sure if the specification wants the type names to also be Observable* or just the methods. The quoted sections are for the creation methods of each instrument, which makes me think it is recommending the method name only. Not 100% sure though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:metrics Part of OpenTelemetry Metrics bug Something isn't working pkg:API Related to an API package
Projects
No open projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant