Skip to content

docs: add troubleshooting guide for common plugin issues - #1283

Open
Vaishnav88sk wants to merge 6 commits into
jenkinsci:mainfrom
Vaishnav88sk:docs/troubleshooting-guide-for-common-issues
Open

docs: add troubleshooting guide for common plugin issues#1283
Vaishnav88sk wants to merge 6 commits into
jenkinsci:mainfrom
Vaishnav88sk:docs/troubleshooting-guide-for-common-issues

Conversation

@Vaishnav88sk

Copy link
Copy Markdown

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

  • No traces appearing in the backend (endpoint checklist, collector config)
  • OTLP connection refused or timeout (causes table + fix)
  • Metrics missing in Prometheus (allow-list config, collector pipeline setup)
  • Pipeline logs not visible in Elastic or Loki (log export config, mirror-to-disk)
  • ClassCircularityError on plugin install (ClassCircularityError thrown when installing the plugin #1201)
  • Traces appear but spans are missing stages (parallel branches, withSpanAttribute)
  • Build agents cannot reach the OTLP endpoint (agent-side export explanation)
  • Enabling debug logging (log recorder steps + caveat about build logs)

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

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests that demonstrate the feature works or the issue is fixed

Fixes #1275

…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>
@Vaishnav88sk
Vaishnav88sk requested a review from a team as a code owner April 14, 2026 10:49
@Vaishnav88sk

Copy link
Copy Markdown
Author

@kuisathaverat

@v1v v1v left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Resolves PR review feedback

Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
@Vaishnav88sk

Copy link
Copy Markdown
Author

I can see some specific sections for troubleshooting in other docs:

Wonder if they should be centrallised here too

@v1v Great suggestion! I've just updated the PR to extract the troubleshooting sections from build-logs.md and EDOT.md and centralized them into the new guide. I also left links in the original files pointing to the centralized section.

@Vaishnav88sk
Vaishnav88sk requested a review from v1v June 9, 2026 13:45
Comment thread docs/EDOT.md Outdated
Comment thread docs/build-logs.md Outdated
Resolves PR review feedback

Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
@Vaishnav88sk
Vaishnav88sk requested a review from v1v June 26, 2026 06:12
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.

Missing troubleshooting guide for common configuration and connectivity issues

2 participants