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

Document common usecases and recommended usage #688

Open
eyjohn opened this issue Apr 21, 2021 · 4 comments
Open

Document common usecases and recommended usage #688

eyjohn opened this issue Apr 21, 2021 · 4 comments
Labels
do-not-stale documentation Improvements or additions to documentation

Comments

@eyjohn
Copy link
Contributor

eyjohn commented Apr 21, 2021

(came up during OpenTelemetry C++ SIG)

Creating this issue to track the common use-cases that we want to document in more detail. It would be ideal to add this documentation to readthedocs/Getting Started so that these common users can get started quickly without having to fully understand all the build options.

We can start in the roles defined in the specification here https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#user-roles

I've interpreted these roles to map to the use-cases of:

  • Application Owner - I want my application to generate telemetry, I need to use sdk (and possibly install a vendor-specific)
  • Instrumentation Author - Any-one using the api to instrument their application OR library code
  • Library Author - A library that is instrumented using the api but is intended to be used by other applications (or libraries) and may be distributed by itself
  • Plugin Author - Someone (likely a vendor) who uses sdk and provides an SDK plugin that application owners can install

Please add comments for any use-cases that you may be interested in.

@lalitb lalitb added this to the 1.0.0-rc.1 milestone Apr 26, 2021
@lalitb lalitb added the documentation Improvements or additions to documentation label Apr 27, 2021
@lalitb
Copy link
Member

lalitb commented Jun 3, 2021

Moving to GA milestone, as this is related to documentation.

@lalitb lalitb modified the milestones: 1.0.0-rc.1, 1.0.0 GA Jun 3, 2021
@reyang reyang removed this from the 1.0.0 milestone Sep 23, 2021
@github-actions
Copy link

This issue was marked as stale due to lack of activity. It will be closed in 7 days if no furthur activity occurs.

@github-actions github-actions bot added the Stale label Nov 23, 2021
@lalitb lalitb removed the Stale label Nov 23, 2021
@github-actions
Copy link

This issue was marked as stale due to lack of activity. It will be closed in 7 days if no furthur activity occurs.

@github-actions
Copy link

This issue was marked as stale due to lack of activity. It will be closed in 7 days if no furthur activity occurs.

@github-actions github-actions bot added the Stale label Mar 25, 2022
@lalitb lalitb removed the Stale label Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-stale documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants