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

Move OpenTelemetry API to top level go.opentelemetry.io/otel package #964

Closed
MrAlias opened this issue Jul 24, 2020 · 4 comments · Fixed by #1262
Closed

Move OpenTelemetry API to top level go.opentelemetry.io/otel package #964

MrAlias opened this issue Jul 24, 2020 · 4 comments · Fixed by #1262
Assignees
Labels
area:metrics Part of OpenTelemetry Metrics area:trace Part of OpenTelemetry tracing pkg:API Related to an API package
Milestone

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Jul 24, 2020

In a recent review of the project, one of the things identified that we can do to ease discoverability instrumentation structures and ease adoption of the project for new users is to move relevant instrumentation structures and interfaces in the top level package.

This means taking tracing and metric APIs and moving them to the go.opentelemetry.io/otel package. Namely:

  • go.opentelemetry.io/otel/api/trace
    • Provider
      • Rename to TraceProvider
    • Span
    • Tracer
  • go.opentelemetry.io/otel/api/metric
    • BatchObserver
    • BatchObserverCallback
    • BoundFloat64Counter
    • BoundFloat64UpDownCounter
    • BoundFloat64ValueRecorder
    • BoundInt64Counter
    • BoundInt64UpDownCounter
    • BoundInt64ValueRecorder
    • Float64Counter
    • Float64ObserverCallback
    • Float64ObserverResult
    • Float64SumObserver
    • Float64UpDownCounter
    • Float64UpDownSumObserver
    • Float64ValueObserver
    • Float64ValueRecorder
    • Int64Counter
    • Int64ObserverCallback
    • Int64ObserverResult
    • Int64SumObserver
    • Int64UpDownCounter
    • Int64UpDownSumObserver
    • Int64ValueObserver
    • Int64ValueRecorder
    • Meter
    • Observation
    • Provider
      • Rename to MeterProvider

This is not a comprehensive list. There are likely other elements of the API that need to be moved or re-engineered in the move.

@MrAlias MrAlias added pkg:API Related to an API package area:metrics Part of OpenTelemetry Metrics area:trace Part of OpenTelemetry tracing release:required-for-ga labels Jul 24, 2020
@lizthegrey
Copy link
Member

May relate to #940 to separate API package from SDK packages to minimize dependency set for using OTel API only.

@MrAlias
Copy link
Contributor Author

MrAlias commented Jul 24, 2020

Investigation of how we want to position the global package will have to be included in this work.

@MrAlias
Copy link
Contributor Author

MrAlias commented Aug 20, 2020

@MrAlias
Copy link
Contributor Author

MrAlias commented Aug 24, 2020

This should resolve #448

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 area:trace Part of OpenTelemetry tracing pkg:API Related to an API package
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants