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

*Impl type names are confusing #1284

Closed
rakyll opened this issue Oct 27, 2020 · 1 comment
Closed

*Impl type names are confusing #1284

rakyll opened this issue Oct 27, 2020 · 1 comment
Labels
area:metrics Part of OpenTelemetry Metrics pkg:API Related to an API package
Projects

Comments

@rakyll
Copy link
Contributor

rakyll commented Oct 27, 2020

Per spec, https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/metrics, there are various metrics interfaces that sit in the boundary of the SDK and the API. These types are named as "*Impl" which resembles "implementation" types from other languages. Is there a better way to rename them to avoid the confusion that they are concrete types.

For example, MeterImpl sounds like a concrete type for Meter even though it's not. In Go, *Impl is not a naming convention for concrete types either. So the API surface looks unidiomatic and harder to navigate from the users perspective.

@rakyll rakyll changed the title *Impl type names are confusing to Go developers *Impl type names are confusing Oct 28, 2020
@MrAlias MrAlias added area:metrics Part of OpenTelemetry Metrics pkg:API Related to an API package priority:p1 labels Oct 29, 2020
@MrAlias MrAlias added this to To do in P1 Burndown via automation Oct 29, 2020
@MrAlias MrAlias added this to To do in OpenTelemetry Go RC via automation Oct 29, 2020
@MrAlias MrAlias added this to the RC1 milestone Oct 29, 2020
@MrAlias MrAlias removed this from the RC1 milestone Feb 12, 2021
@punya punya removed this from To do in OpenTelemetry Go RC Feb 17, 2021
@MrAlias
Copy link
Contributor

MrAlias commented May 3, 2022

Resolved by #2587

@MrAlias MrAlias closed this as completed May 3, 2022
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 pkg:API Related to an API package
Projects
No open projects
P1 Burndown
  
To do
Development

No branches or pull requests

2 participants