-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Unify internal observability documentation - 2 of 3 #4322
Conversation
Just getting started. I'll tag everyone when it's ready for review. Thanks! |
Hi @svrnm , @theletterf, @mx-psi, @codeboten, This PR is ready for review. I'm also adding a few in-line comments and questions for the group. Thanks! |
This looks really good, I answered some of your questions. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of good stuff in here. Thanks so much, @tiffany76 !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work. See inline for questions, remarks, and suggestions. Thanks.
I've addressed all the comments and suggestions made so far. If anyone would like to take another look, now's your chance. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! A few more comments, see inline. Thx
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
Good to merge here @svrnm? |
Yes! |
Great work @tiffany76 et all! 🙌🏻 🎉 |
#### Description Now that [4246](open-telemetry/opentelemetry.io#4246), [4322](open-telemetry/opentelemetry.io#4322), and [4529](open-telemetry/opentelemetry.io#4529) have been merged, and the new [Internal telemetry](https://opentelemetry.io/docs/collector/internal-telemetry/) and [Troubleshooting](https://opentelemetry.io/docs/collector/troubleshooting/) pages are live, it's time to clean up the underlying Collector repo docs so that the website is the single source of truth. I've deleted any content that was moved to the website, and linked to the relevant sections where possible. I've consolidated what content remains in the observability.md file and left troubleshooting.md and monitoring.md as stubs that point to the website. I also searched the Collector repo for cross-references to these files and adjusted links where appropriate. ~~Note that this PR is blocked by [4731](open-telemetry/opentelemetry.io#4731 EDIT: #4731 is merged and no longer a blocker. <!-- Issue number if applicable --> #### Link to tracking issue Fixes #8886
This PR is the second of three. Together they will create a new internal observability document on opentelemetry.io, combining and migrating multiple markdown files from the Collector repo. This PR covers the section on types of internal observability.
Link to tracking issue: open-telemetry/opentelemetry-collector#8886.
Also fixes #4278.
Also relates to:
Follow up PR (3 of 3) will be created once this one is merged.
PREVIEW: https://deploy-preview-4322--opentelemetry.netlify.app/docs/collector/internal-telemetry/