Unify internal observability documentation - 3 of 3 #4529
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Still working on copy edits. I hope to move it out of draft mode tomorrow, but there's a good chance it won't happen until after the US holiday on Monday. |
tiffany76
requested review from
a team and
TylerHelmuth
and removed request for
a team
tiffany76
commented
May 30, 2024
|
Ready for review. I flagged one section that I'm having trouble with. Thanks! |
theletterf
approved these changes
Jun 3, 2024
|
@open-telemetry/collector-approvers PTAL |
Co-authored-by: Fabrizio Ferri-Benedetti <fferribenedetti@splunk.com>
|
/fix:format |
|
You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/9357775924 |
|
@open-telemetry/collector-approvers, does anyone have time to give this PR a look? It's a pretty straightforward transfer and edit of the content from the Collector repo docs. And I've pointed out one section that might need some extra work. Thanks! |
mx-psi
reviewed
Jun 11, 2024
mx-psi
approved these changes
Jun 14, 2024
|
🚀 You did it! Wohoo! |
mx-psi
pushed a commit
to open-telemetry/opentelemetry-collector
that referenced
this pull request
Jun 28, 2024
#### 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the last 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 monitoring the Collector with internal telemetry.
The Collector repo documents have some overlap between monitoring and troubleshooting, and this PR makes changes to both of those sections on the website.
Link to tracking issue: open-telemetry/opentelemetry-collector#8886. (Not triggering a closure on this until I can update/remove the Collector repo docs.)
Also fixes #3894.
Also relates to:
Previews:
Monitoring
Troubleshooting