Skip to content

feat: Add OTel Collector internal metrics doc & dashboard page - #3545

Merged
crazyuploader merged 5 commits into
mainfrom
feat/add-otel-collector-metrics-docs
Jun 29, 2026
Merged

feat: Add OTel Collector internal metrics doc & dashboard page#3545
crazyuploader merged 5 commits into
mainfrom
feat/add-otel-collector-metrics-docs

Conversation

@crazyuploader

@crazyuploader crazyuploader commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Pull Request


📄 Summary

This PR adds OpenTelemetry internal metrics doc and dashboard template page.

Part of: SigNoz/dashboards#379

Doc Links:

@crazyuploader crazyuploader self-assigned this Jun 23, 2026
@crazyuploader crazyuploader added the documentation Improvements or additions to documentation label Jun 23, 2026
@vercel

vercel Bot commented Jun 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview, Comment Jun 29, 2026 6:42am

Request Review

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Claude finished @crazyuploader's task in 5m 31s —— View job


Docs Review Summary

  • Gather context and read changed files
  • Run JTBD-first rubric and technical verification
  • Post inline findings and summary

Findings

P1 — Dashboard JSON URL 404 (opentelemetry-collector-dashboard.mdx:23)
The dashboardJsonUrl points to SigNoz/dashboards/opentelemetry-collector/opentelemetry-collector.json, which does not exist in the SigNoz/dashboards repo. The "Import Dashboard" button will break for users. A companion PR to that repo is needed before merging.

P2 — Meta description too long (opentelemetry-collector-metrics.mdx:5)
At 192 characters, the metrics doc description exceeds the 120–160 character guideline. Suggested trim in the inline comment.

P3 — Dashboard title 1 char under minimum (opentelemetry-collector-dashboard.mdx:5)
Title is 49 characters vs. the 50-character minimum. Minor — suggestion in inline comment.

P3 — Inconsistent trailing period (opentelemetry-collector-metrics.mdx:172)
Third "Next Steps" bullet is missing the . that the other two have.

Personas & JTBD Coverage

  • Primary persona: Platform engineer / DevOps running OTel Collector(s) in production.
  • Primary job: "When my Collector pipelines handle production traffic, I want to monitor their internal health, so I can catch drops, queue pressure, and resource issues before they impact data delivery."
  • The metrics doc covers a clean happy path: configure telemetry reader → restart → validate in Metrics Explorer. VM / Docker / Kubernetes tabs are well-structured.
  • The dashboard doc follows the template pattern: prerequisite link, screenshot, DashboardActions, metric descriptions, and related dashboards.

Checklist Coverage

Check Status
Frontmatter (date, id, title, description, doc_type) ✅ Present on both docs
Title length (50–60 chars) ✅ Metrics (59) · ⚠️ Dashboard (49)
Description length (120–160 chars) ❌ Metrics (192) · ✅ Dashboard (120)
doc_type fits content howto for metrics, explanation for dashboard
Happy path clear and minimal
Validate section ✅ Metrics Explorer search shown
Troubleshooting ✅ Collapsed with symptom→cause→fix
Next steps ✅ Dashboard, alerts, config links
Internal links use absolute URLs ✅ All use https://signoz.io/docs/...
Internal link targets exist ✅ All verified
Images WebP ≥1200px, Figure with alt text ✅ 3000×1652 and 2982×1846
Sidebar nav updated ✅ Both entries in correct positions
Discovery surfaces updated dashboard-templates.json and metrics-quick-start.json
Placeholders documented <region>, <your-ingestion-key>, <service-name> explained
Technical accuracy (OTel config) service.telemetry.metrics.readers with periodic OTLP exporter is correct per OTel docs; interval: 60000 (ms) is correct; level descriptions accurate

Open Questions

  • The dashboard JSON needs to exist in SigNoz/dashboards before merge — is there a companion PR for that?

Onboarding Label

Onboarding label: appliedopentelemetry-collector-metrics.mdx is a new doc whose primary job is sending Collector internal metrics to SigNoz, with concrete ingestion setup (endpoint + key). The dashboard template page does not qualify per policy.


Comment thread data/docs/dashboards/dashboard-templates/opentelemetry-collector-dashboard.mdx Outdated
Comment thread data/docs/metrics-management/opentelemetry-collector-metrics.mdx Outdated
Comment thread data/docs/metrics-management/opentelemetry-collector-metrics.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

📚 Onboarding issue created… see #3547

@github-actions

Copy link
Copy Markdown
Contributor

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 2
🔄 Updated 0
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Created /dashboards/dashboard-templates/opentelemetry-collector-dashboard
Created /metrics-management/opentelemetry-collector-metrics

@github-actions

Copy link
Copy Markdown
Contributor

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 2
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Updated /dashboards/dashboard-templates/opentelemetry-collector-dashboard
Updated /metrics-management/opentelemetry-collector-metrics

📋 Listicle Sync

Operation Count
✅ Created 0
🔄 Updated 24
🗑️ Deleted 0
View 24 listicle(s)
Operation Listicle
Updated apm-dashboards
Updated apm-instrumentation
Updated apm-quick-start
Updated aws-monitoring
Updated aws-one-click
Updated azure-one-click
Updated cicd-monitoring
Updated collection-agents
Updated dashboard-templates
Updated host-metrics-dashboards
Updated integrations
Updated java-instrumentation
Updated javascript-instrumentation
Updated k8s-installation
Updated kubernetes-dashboards
Updated litellm-dashboards
Updated llm-monitoring
Updated logs-instrumentation
Updated logs-quick-start
Updated marketplace-installation
Updated metrics-quick-start
Updated migrate-to-signoz
Updated self-host-installation
Updated web-vitals

@github-actions

Copy link
Copy Markdown
Contributor

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 2
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Updated /dashboards/dashboard-templates/opentelemetry-collector-dashboard
Updated /metrics-management/opentelemetry-collector-metrics

📋 Listicle Sync

Operation Count
✅ Created 0
🔄 Updated 24
🗑️ Deleted 0
View 24 listicle(s)
Operation Listicle
Updated apm-dashboards
Updated apm-instrumentation
Updated apm-quick-start
Updated aws-monitoring
Updated aws-one-click
Updated azure-one-click
Updated cicd-monitoring
Updated collection-agents
Updated dashboard-templates
Updated host-metrics-dashboards
Updated integrations
Updated java-instrumentation
Updated javascript-instrumentation
Updated k8s-installation
Updated kubernetes-dashboards
Updated litellm-dashboards
Updated llm-monitoring
Updated logs-instrumentation
Updated logs-quick-start
Updated marketplace-installation
Updated metrics-quick-start
Updated migrate-to-signoz
Updated self-host-installation
Updated web-vitals

@crazyuploader
crazyuploader force-pushed the feat/add-otel-collector-metrics-docs branch from 7470a2e to eab8be5 Compare June 29, 2026 06:38
@github-actions

Copy link
Copy Markdown
Contributor

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 2
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Updated /dashboards/dashboard-templates/opentelemetry-collector-dashboard
Updated /metrics-management/opentelemetry-collector-metrics

📋 Listicle Sync

Operation Count
✅ Created 0
🔄 Updated 2
🗑️ Deleted 0
View 2 listicle(s)
Operation Listicle
Updated dashboard-templates
Updated metrics-quick-start

@crazyuploader
crazyuploader merged commit 7b0589a into main Jun 29, 2026
9 checks passed
@crazyuploader
crazyuploader deleted the feat/add-otel-collector-metrics-docs branch June 29, 2026 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add-to-onboarding documentation Improvements or additions to documentation staging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants