Unify internal observability documentation - 1 of 3 #4246
Conversation
|
Still lots to do. Will start working on the content tomorrow. |
|
Thanks again, @tiffany76 ! Let us know when you want us to run a first review pass. |
|
/fix:refcache |
|
You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/8576259476 |
tiffany76
requested review from
a team and
bogdandrutu
and removed request for
a team
Ready for review! Make sure to view the preview because the rich diff doesn't render the tabbed panes. :) |
There was a problem hiding this comment.
Excellent work!
I'd place this document as a sub-doc for Troubleshooting. WDYT @svrnm ?
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Pablo Baeyens <[email protected]>
I agree. Profiling looks out of the scope of this work. It may be even better to utilize profiling once it's part of OTel as a new signal. |
|
So, looks like we're almost there? Only thing to be resolved is the Grafana dashboard question, right? |
I just saw that my comments on that matter where still "pending", just submitted them! |
Co-authored-by: Severin Neumann <[email protected]>
|
@svrnm I think this one is ready, but please let me know if you find any other changes I should make. Thanks! |
Co-authored-by: Pablo Baeyens <[email protected]>
|
🎉 thank you @tiffany76 |
| Self-monitoring is a risky practice. If an issue arises, the source of the | ||
| problem is unclear and the telemetry is unreliable. |
There was a problem hiding this comment.
Late to the party, but this caution text doesn't make sense / is incomplete.
There was a problem hiding this comment.
I changed the caution text in #4322. Please let me know if the new alert makes more sense.
There was a problem hiding this comment.
Great, thanks! I'll add comments, if any in #4322.
#### 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
Link to tracking issue: open-telemetry/opentelemetry-collector#8886.
Relates to #4192. For ease of review, that larger PR is being split into three smaller ones. This is the first of three.
This PR addresses the first section of a new internal observability document on opentelemetry.io:
Follow up PRs (2 and 3 of 3) will be created once this one is merged.
cc: @mx-psi @codeboten @theletterf @svrnm
Preview: https://deploy-preview-4246--opentelemetry.netlify.app/docs/collector/internal-telemetry/