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

Define conventions for Registry types. #595

Open
austinlparker opened this issue May 11, 2020 · 1 comment
Open

Define conventions for Registry types. #595

austinlparker opened this issue May 11, 2020 · 1 comment
Labels
area:miscellaneous For issues that don't match any other area label enhancement New feature or request needs discussion Need more information before all suitable labels can be applied priority:p2 Medium priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs

Comments

@austinlparker
Copy link
Member

I'm working on Registry enhancements (see open-telemetry/opentelemetry.io#103 (comment) for a WIP image) that requires a quick consensus on a few names. We'll have the ability in the registry to filter by both language and 'type'. Here's my proposed types -

  • API
  • SDK
  • Instrumentation
  • Collector
  • Exporter

Open questions:

  1. Should API and SDK be combined? They're separate because some SIGs have a separate API and SDK implementation, but I'm not entirely convinced that's the best option. A potential change here would be to combine API and SDK into 'Implementations' and allow for multiple URLs for this type (so you could link to API and SDK independently if they are in independent repositories)
  2. Are we happy with 'Instrumentation' to be a catch-all for instrumentation plugins? Is this terminology confusing to new users? We can also just display it as 'Instrumentation Plugin' and keep the underlying type key 'instrumentation'
  3. Should 'Collector' be a type or a language (or both?) The current taxonomy makes collector exporters kinda weird, as they're exporters (so they should be tagged exporter) but they're for the collector (so they should be tagged collector).
  4. Is there anything missing?

Thanks in advance for feedback.

@austinlparker
Copy link
Member Author

After noodling on this a bit, I'm thinking about combining API and SDK into 'Core', so we'd have 'Core', 'Collector', 'Exporter', and 'Instrumentation'.

@reyang reyang added enhancement New feature or request needs discussion Need more information before all suitable labels can be applied labels Jun 26, 2020
@carlosalberto carlosalberto added area:miscellaneous For issues that don't match any other area label release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Jul 10, 2020
@bogdandrutu bogdandrutu added the priority:p2 Medium priority level label Jul 24, 2020
@andrewhsu andrewhsu added release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs and removed release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Sep 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:miscellaneous For issues that don't match any other area label enhancement New feature or request needs discussion Need more information before all suitable labels can be applied priority:p2 Medium priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs
Projects
None yet
Development

No branches or pull requests

5 participants