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

Add instrumentation details to each README.md #742

Open
11 tasks
breedx-splk opened this issue Jan 13, 2025 · 0 comments
Open
11 tasks

Add instrumentation details to each README.md #742

breedx-splk opened this issue Jan 13, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@breedx-splk
Copy link
Contributor

breedx-splk commented Jan 13, 2025 •
edited
Loading

New users have no quick/easy way to determine what telemetry is provided by the various instrumentations here. This is a tracking issue and proposal to add specific details about the telemetry generated by each instrumentation.

For each instrumentation module, there should be a corresponding README.md file that provides:

  • a description what the instrumentation does
  • whether it is enabled by default via the agent
  • how to configure it
  • specific details about the instrumentation it provides.

Here is an instrumentation checklist that should be complete before this issue can be closed:
@breedx-splk breedx-splk added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 13, 2025
@breedx-splk breedx-splk mentioned this issue Jan 16, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@breedx-splk