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

Documentation for library instrumentations #6947

Open
15 of 31 tasks
trask opened this issue Oct 22, 2022 · 2 comments
Open
15 of 31 tasks

Documentation for library instrumentations #6947

trask opened this issue Oct 22, 2022 · 2 comments
Labels
contribution welcome Request makes sense, maintainers probably won't have time, contribution would be welcome documentation Improvements or additions to documentation

Comments

@trask
Copy link
Member

trask commented Oct 22, 2022 •
edited
Loading

Documentation is missing for several library instrumentations (https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/standalone-library-instrumentation.md).

This is full list of library instrumentations, check marks mean documentation is present.

It would be great for all of the library instrumentations to follow a layout similar to OkHttp.
@trask trask mentioned this issue Oct 22, 2022
Merged
@aaron-ai aaron-ai mentioned this issue Oct 23, 2022
Closed
trask added a commit that referenced this issue Oct 24, 2022
@trask
Library doc cleanup (#6948)
71b3e3e 
Related to #6947, but just cleans up the library module doc that already
existed (mostly for uniformity). Does not introduce any new doc.
@aaron-ai aaron-ai mentioned this issue Oct 26, 2022
Closed
LironKS pushed a commit to helios/opentelemetry-java-instrumentation that referenced this issue Oct 31, 2022
@trask @LironKS
Library doc cleanup (open-telemetry#6948)
753d957 
Related to open-telemetry#6947, but just cleans up the library module doc that already
existed (mostly for uniformity). Does not introduce any new doc.
@gabrielgiussi
Copy link

Could the docs include which are the metrics reported by the instrumentation?

@trask trask added the contribution welcome Request makes sense, maintainers probably won't have time, contribution would be welcome label Nov 22, 2022
@trask trask pinned this issue Nov 22, 2022
@trask trask unpinned this issue Nov 22, 2022
LironKS pushed a commit to helios/opentelemetry-java-instrumentation that referenced this issue Dec 4, 2022
@trask @LironKS
Library doc cleanup (open-telemetry#6948)
f2b203c 
Related to open-telemetry#6947, but just cleans up the library module doc that already
existed (mostly for uniformity). Does not introduce any new doc.
@trask trask mentioned this issue Dec 12, 2022
Merged
@trask trask mentioned this issue Feb 27, 2023
Merged
This was referenced Jul 30, 2023
Merged
Merged
@jaydeluca
Copy link
Member

I wrote a script to identify all the library instrumentations and then whether or not they have a readme:

@jaydeluca jaydeluca added the documentation Improvements or additions to documentation label Jan 7, 2025
@trask trask pinned this issue Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
contribution welcome Request makes sense, maintainers probably won't have time, contribution would be welcome documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@trask @gabrielgiussi @jaydeluca