docs: add troubleshooting guide for common plugin issues - #1283
Open
Vaishnav88sk wants to merge 6 commits into
Open
docs: add troubleshooting guide for common plugin issues#1283Vaishnav88sk wants to merge 6 commits into
Vaishnav88sk wants to merge 6 commits into
Conversation
…users Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
… issues added Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
… issues added Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
Author
v1v
reviewed
Jun 1, 2026
v1v
left a comment
Member
There was a problem hiding this comment.
I can see some specific sections for troubleshooting in other docs:
- https://github.com/jenkinsci/opentelemetry-plugin/blob/main/docs/build-logs.md#troubleshooting
- https://github.com/jenkinsci/opentelemetry-plugin/blob/main/docs/EDOT.md#troubleshooting
Wonder if they should be centrallised here too
Resolves PR review feedback Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
Author
@v1v Great suggestion! I've just updated the PR to extract the troubleshooting sections from |
v1v
reviewed
Jun 11, 2026
Resolves PR review feedback Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
This file contains hidden or 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
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.
What this PR does
Adds
docs/troubleshooting.md- a new troubleshooting guide covering the most frequently reported issues with the Jenkins OpenTelemetry plugin.Sections covered
Why
The existing docs (setup-and-configuration.md, build-logs.md) explain how to configure the plugin but do not help users diagnose why something is not working. Issues like #1201, #380, and several others in the tracker show the same root causes recurring without a central reference. This guide consolidates those fixes in one place.
Testing done
Documentation only - no code changes. Verified all cross-links point to existing docs files.
Submitter checklist
Fixes #1275