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

Separate API from SDK #721

Closed
dyladan opened this issue Jan 22, 2020 · 5 comments · Fixed by #727
Closed

Separate API from SDK #721

dyladan opened this issue Jan 22, 2020 · 5 comments · Fixed by #727
Assignees
Labels
Discussion Issue or PR that needs/is extended discussion.

Comments

@dyladan
Copy link
Member

dyladan commented Jan 22, 2020

cc: @mayurkale22

Currently a library wishing to integrate OpenTelemetry JS has to import core in order to acquire a tracer from the global tracer registry. core is a part of the SDK and contains many other SDK components.

Proposal: Create a new package named @opentelemetry/api which exposes the public API.

This new package would be the only thing library authors would depend on. It would export all types from the types package, as well as take over the global tracer utils responsibilities from core. Its API surface consists only of the public API and nothing else. This means the functions to get and set the global tracer registry, and types.

@dyladan dyladan added the Discussion Issue or PR that needs/is extended discussion. label Jan 22, 2020
@dyladan
Copy link
Member Author

dyladan commented Jan 22, 2020

cc: @open-telemetry/javascript-approvers

@mayurkale22
Copy link
Member

What if we rename @opentelemetry/types => @opentelemetry/api and move API specific components from core package there?

@dyladan
Copy link
Member Author

dyladan commented Jan 22, 2020

I would be fine with that as well

@dyladan dyladan self-assigned this Jan 22, 2020
@dyladan dyladan mentioned this issue Jan 22, 2020
@mayurkale22
Copy link
Member

mayurkale22 commented Jan 22, 2020

Just wanted to attach original package structure issue: #6. Edit: We considered api name before.

@dyladan
Copy link
Member Author

dyladan commented Jan 22, 2020

Just wanted to attach original package structure issue: #6

Thanks. As a separate issue, I want to rename all the packages/opentelemetry-* directories to packages/*. If every package is going to have it then it doesn't seem that important to keep and is annoying to type over and over.

@dyladan dyladan changed the title Create new api package Separate API from SDK Jan 29, 2020
pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this issue Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Issue or PR that needs/is extended discussion.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants