Skip to content

docs(collector): add Kubernetes troubleshooting guidance#8884

Merged
tiffany76 merged 5 commits intoopen-telemetry:mainfrom
MUSKANNISHAD:docs-add-k8s-troubleshooting
Mar 1, 2026
Merged

docs(collector): add Kubernetes troubleshooting guidance#8884
tiffany76 merged 5 commits intoopen-telemetry:mainfrom
MUSKANNISHAD:docs-add-k8s-troubleshooting

Conversation

@MUSKANNISHAD
Copy link
Copy Markdown
Contributor

@MUSKANNISHAD MUSKANNISHAD commented Jan 13, 2026 •
edited
Loading

  • I have read and followed the Contributing docs, especially the "First-time contributing?" section.
  • This PR has content that I did not fully write myself.
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

This PR adds Kubernetes-specific troubleshooting guidance for the OpenTelemetry
Collector, including an example using kubectl debug with an ephemeral
container to diagnose networking and runtime issues.

Fixes #6129

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩

@MUSKANNISHAD MUSKANNISHAD requested a review from a team as a code owner January 13, 2026 10:42
@otelbot-docs otelbot-docs Bot requested review from a team and jade-guiton-dd and removed request for a team January 13, 2026 10:42
@MUSKANNISHAD MUSKANNISHAD force-pushed the docs-add-k8s-troubleshooting branch from cc8af89 to 6147c8f Compare January 13, 2026 10:58
@otelbot-docs otelbot-docs Bot requested a review from a team January 13, 2026 10:58
@tiffany76
Copy link
Copy Markdown
Member

tiffany76 commented Jan 13, 2026

Thanks, @MUSKANNISHAD!

@open-telemetry/collector-approvers and @atoulme, PTAL.

@dmathieu
Copy link
Copy Markdown
Member

dmathieu commented Jan 14, 2026

While this information can indeed be useful, it is also overly generic. Attaching onto a running container is far from being otel-specific.
So while this advice looks good, I'm not sure the otel doc is a good location.

@MUSKANNISHAD MUSKANNISHAD force-pushed the docs-add-k8s-troubleshooting branch from b2f5a1d to 35206a1 Compare January 14, 2026 10:26
@MUSKANNISHAD
Copy link
Copy Markdown
Contributor Author

MUSKANNISHAD commented Jan 14, 2026

Thanks for the feedback! That makes sense.
I agree the technique itself is generic Kubernetes advice. My intention was to document how it can be applied specifically to troubleshooting OpenTelemetry Collector issues (e.g. exporter connectivity, DNS resolution for backends, or receiver port reachability).

I can update the section to make the OpenTelemetry-specific context clearer, or adjust the location if there’s a more appropriate place for this content. Happy to revise based on your preference.

mx-psi
mx-psi reviewed Jan 29, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@mx-psi mx-psi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I wonder if instead of adding that we can just add a link to https://kubernetes.io/docs/tasks/debug/debug-application/debug-running-pod/#ephemeral-container

I agree with @dmathieu that the info is overly generic, maybe adding that link is enough and we leave it to Kubernetes to document this

@otelbot-docs otelbot-docs Bot requested review from a team January 30, 2026 07:50
@vitorvasc
Copy link
Copy Markdown
Member

vitorvasc commented Feb 2, 2026

/fix:all

@otelbot-docs
Copy link
Copy Markdown
Contributor

otelbot-docs Bot commented Feb 2, 2026

✅ fix:all applied successfully in run 21586093161.

@github-actions github-actions Bot added the sig:go label Feb 2, 2026
@otelbot-docs otelbot-docs Bot requested review from a team and codeboten and removed request for a team February 2, 2026 10:26
mx-psi
mx-psi reviewed Feb 3, 2026
View reviewed changes
Comment thread content/en/docs/languages/go/getting-started.md Outdated
)
return loggerProvider, nil
}

Copy link
Copy Markdown
Member

@mx-psi mx-psi Feb 3, 2026

Choose a reason for hiding this comment

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

Can you undo this unrelated change? Otherwise LGTM

Copy link
Copy Markdown
Contributor Author

@MUSKANNISHAD MUSKANNISHAD Feb 4, 2026

Choose a reason for hiding this comment

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

Done — the unrelated Go getting-started change has been reverted.
Thanks for catching it!

Copy link
Copy Markdown
Member

@mx-psi mx-psi Feb 4, 2026

Choose a reason for hiding this comment

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

This seems to still be here

Copy link
Copy Markdown
Contributor Author

@MUSKANNISHAD MUSKANNISHAD Feb 6, 2026

Choose a reason for hiding this comment

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

Thanks for the review and the guidance. I’ve reduced the Kubernetes section to a minimal, Collector-specific note, fixed the formatting issues. Please let me know if this looks good now.

Copy link
Copy Markdown
Member

@mx-psi mx-psi Feb 6, 2026

Choose a reason for hiding this comment

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

The line is still there, please take another look.

@MUSKANNISHAD I also wanted to ask you if you are using an LLM to write the comments on this PR. Is that the case?

Copy link
Copy Markdown
Member

@vitorvasc vitorvasc Feb 23, 2026

Choose a reason for hiding this comment

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

Hi @MUSKANNISHAD - did you have a chance to see @mx-psi's comment above?

Also, I've updated the PR description to include the questions from our latest template. Could you please fill it out and check the boxes to indicate if you've used any AI-generated content?

Thanks!

@otelbot-docs otelbot-docs Bot requested a review from a team February 6, 2026 05:20
@MUSKANNISHAD MUSKANNISHAD force-pushed the docs-add-k8s-troubleshooting branch 2 times, most recently from a25a670 to 96c0437 Compare February 6, 2026 05:32
@MUSKANNISHAD MUSKANNISHAD force-pushed the docs-add-k8s-troubleshooting branch from 96c0437 to e1b96f9 Compare February 6, 2026 05:37
@otelbot-docs otelbot-docs Bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Feb 23, 2026
tiffany76
tiffany76 reviewed Mar 1, 2026
View reviewed changes
Comment thread content/en/docs/collector/troubleshooting.md Outdated
@tiffany76
Copy link
Copy Markdown
Member

tiffany76 commented Mar 1, 2026

/fix:format

@otelbot-docs
Copy link
Copy Markdown
Contributor

otelbot-docs Bot commented Mar 1, 2026

✅ fix:format applied successfully in run 22545247818.

@tiffany76
Copy link
Copy Markdown
Member

tiffany76 commented Mar 1, 2026

Thanks, @MUSKANNISHAD.

As the Collector docs refactoring is moving forward, we need to clean up some of the outstanding PRs to avoid conflicts. I made one additional change, which I think now addresses all the concerns of the Collector folks. I'm going to merge. If there are any lingering issues I missed, comment here and I'll raise follow-up issues. Thanks.

@tiffany76 tiffany76 enabled auto-merge March 1, 2026 14:28
@otelbot-docs otelbot-docs Bot removed the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label Mar 1, 2026
@tiffany76 tiffany76 added this pull request to the merge queue Mar 1, 2026
Merged via the queue into open-telemetry:main with commit e75af5f Mar 1, 2026
24 checks passed
@otelbot
Copy link
Copy Markdown
Contributor

otelbot Bot commented Mar 1, 2026

Thank you for your contribution @MUSKANNISHAD! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mx-psi mx-psi mx-psi left review comments

@vitorvasc vitorvasc vitorvasc left review comments

@tiffany76 tiffany76 tiffany76 approved these changes

@codeboten codeboten Awaiting requested review from codeboten codeboten was automatically assigned from open-telemetry/collector-approvers

Assignees

No one assigned

Labels

missing:sig-approval Co-owning SIG didn't provide an approval sig:collector sig:go

Projects

SIG Comms: Docs Translation
Status: Done
SIG Comms: PRs & Issues
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add troubleshooting instructions specific to Kubernetes environments

5 participants

@MUSKANNISHAD @tiffany76 @dmathieu @vitorvasc @mx-psi