-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add "collector troubleshooting" doc #2382
Add "collector troubleshooting" doc #2382
Conversation
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.
This is a great addition and starting point for troubleshooting, thanks!
I also wonder if we can crib some content from vendors about troubleshooting, too. Some of what's in this doc is also helpful, but not all of it. Anyways, happy to take this as-is and iterate on the topic as needed.
@cartermp Agreed, there's good advice (and useful external tools like otel-cli or https://github.com/fullstorydev/grpcurl and https://github.com/CtrlSpice/otel-desktop-viewer) scattered in many places. For advice involving non-community but open-source tools, are we prohibited from linking? |
Off-hand I'd say no, definitely not prohibited. Vendor stuff is what's iffy since we can't favor one over another, even if it's done only because a vendor happens to have the best content for a topic :/ |
We copied some content from vendor's in the past with their approval and adding them into the Acknowledgment section, so I see no issue with doing this once again. |
I am happy to hav this, @smithclay can you give the suggestions from @chalin a look and resolve them, TY! |
cded899
to
83b48d6
Compare
@chalin Thanks for the feedback, have pushed the requested changes + rebased. |
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
83b48d6
to
8f51b71
Compare
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.
Thanks. A few more copy edits (you'll probably have to rerun Prettier after accepting them), see inline. Otherwise LGTM.
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
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, thanks!
This adds a short page that generally points users to the existing collector troubleshooting docs.
Two minor additions not covered in the main doc:
Think a future section that goes deeper into collector observability would be a great future addition.
Preview: https://deploy-preview-2382--opentelemetry.netlify.app/docs/collector/troubleshooting/