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.

Sign up for GitHub

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

Jump to bottom

improv: naming sdks #2146

Closed
vmarchaud opened this issue Apr 22, 2021 · 2 comments · Fixed by #2340
Closed

improv: naming sdks #2146

vmarchaud opened this issue Apr 22, 2021 · 2 comments · Fixed by #2340
Assignees
@vmarchaud
Labels
Discussion Issue or PR that needs/is extended discussion. feature-request

Comments

@vmarchaud
Copy link
Member

Discussed at the SIG, its really confusing to have the sdk term for @opentelemetry/node and @opentelemetry/web (which are the tracing sdks) and the "sdk" term of package with more components (ex: @opentelemetry/sdk-node).
I think we should have:

  • @opentelemetry/node-tracing which is the node tracing sdk
  • @opentelemetry/browser-tracing which is the browser tracing sdk
  • @opentelemetry/node-sdk which bundle every signal SDKs
  • @opentelemetry/browser-sdk same as node sdk but for browser
  • @opentelemetry/node-sdk-all with all components as dependencies
  • @opentelemetry/browser-sdk-all with all components as dependencies
@vmarchaud vmarchaud added feature-request Discussion Issue or PR that needs/is extended discussion. labels Apr 22, 2021
@rauno56
Copy link
Member

rauno56 commented Apr 22, 2021 •
edited
Loading

I'd name them from ordering tokens("isSdk", platform, bundle type) from general to specific:

  • @opentelemetry/sdk-* SDKs of any kind,
  • @opentelemetry/sdk-node-* SDKs for node,
  • @opentelemetry/sdk-node-tracing tracing SDKs for node,
  • @opentelemetry/sdk-node-all all-in-one bundle.

In that way it's simple to see all variants for a sdk, and most likely, when installing one, you know which platform you are looking for as well.

@vmarchaud
Copy link
Member Author

cc @open-telemetry/javascript-approvers

@dyladan dyladan added the up-for-grabs Good for taking. Extra help will be provided by maintainers label Jun 30, 2021
@vmarchaud vmarchaud self-assigned this Jul 11, 2021
@vmarchaud vmarchaud removed the up-for-grabs Good for taking. Extra help will be provided by maintainers label Jul 11, 2021
@vmarchaud vmarchaud mentioned this issue Jul 11, 2021
Merged
vmarchaud added a commit that referenced this issue Aug 5, 2021
@vmarchaud @dyladan
chore: rename sdks to better represent what they are [#2146] (#2340)
a8d3931 
Co-authored-by: Daniel Dyla <[email protected]>
@dyladan dyladan mentioned this issue Aug 17, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vmarchaud vmarchaud

Labels
Discussion Issue or PR that needs/is extended discussion. feature-request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: rename sdks to better represent what they are [#2146] vmarchaud/opentelemetry-js
3 participants
@rauno56 @dyladan @vmarchaud