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.

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

Merged
merged 8 commits into from
Mar 7, 2023

Conversation

smithclay
Copy link
Contributor

@smithclay smithclay commented Feb 22, 2023

This adds a short page that generally points users to the existing collector troubleshooting docs.

Two minor additions not covered in the main doc:

  • Specifically calls out the "sending test data"/local exporter guidance (anecdotally a useful troubleshooting step for users doing first-time collector setup and not seeing data)
  • Adds a high-level checklist of things to verify for complex setups (collectors to collectors, etc)

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/

@smithclay smithclay requested review from a team and Aneurysm9 and removed request for a team February 22, 2023 23:35
Copy link
Contributor

@cartermp cartermp left a 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.

@smithclay
Copy link
Contributor Author

@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?

@cartermp
Copy link
Contributor

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 :/

content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member

svrnm commented Feb 27, 2023

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.

content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
content/en/docs/collector/troubleshooting.md Show resolved Hide resolved
content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member

svrnm commented Mar 4, 2023

I am happy to hav this, @smithclay can you give the suggestions from @chalin a look and resolve them, TY!

@smithclay smithclay force-pushed the collector-troubleshooting branch from cded899 to 83b48d6 Compare March 6, 2023 20:11
@smithclay
Copy link
Contributor Author

@chalin Thanks for the feedback, have pushed the requested changes + rebased.

@chalin chalin force-pushed the collector-troubleshooting branch from 83b48d6 to 8f51b71 Compare March 7, 2023 00:14
Copy link
Contributor

@chalin chalin left a 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.

content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
content/en/docs/collector/troubleshooting.md Outdated Show resolved Hide resolved
smithclay and others added 4 commits March 6, 2023 16:32
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>
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@chalin chalin merged commit 779ec0c into open-telemetry:main Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants