chore: metrics doc revamp

[makeavish]

No description provided.

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
signoz-web	Ready	Preview	Comment	Nov 22, 2025 9:53am

[makeavish]

@claude /review

[claude]

Claude finished @makeavish's task —— View job

---

PR Review Complete

Reviewed PR #2087: chore: metrics doc revamp

Summary

This PR restructures the metrics documentation with improved organization and new guides. The changes include:

• ✅ New overview and entry point pages for metrics
• ✅ Simplified guides for OpenTelemetry receivers and Prometheus metrics
• ✅ Reorganized navigation with better categorization
• ✅ Proper redirects for deleted pages
• ✅ Updated CONTRIBUTING.md and README.md

Issues Found

I've created 5 inline comments for issues that need to be addressed:

1. Broken link in overview.mdx (line 23): Points to deleted /docs/userguide/send-metrics-cloud/ page
2. Relative link in prometheus-metrics.mdx (line 74): Should use absolute URL format
3. Broken link in otel-metrics-receivers.mdx (line 83): Incorrect dashboard path
4. Broken link in prometheus-metrics.mdx (line 87): Incorrect dashboard path
5. Broken link in traefik-observability.mdx (line 115): Incorrect dashboard path

All links should point to /docs/userguide/manage-dashboards/ instead of /docs/userguide/dashboards/.

Technical Accuracy

✅ Verified against official OpenTelemetry sources:

• Receiver configuration structure is accurate (Source: https://opentelemetry.io/docs/collector/configuration/)
• OpenTelemetry Collector Contrib receivers reference is correct (Source: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver)
• Prometheus receiver scrape_configs documentation is accurate (Source: https://opentelemetry.io/docs/collector/configuration/)
• Traefik OTLP metrics/traces gRPC configuration is accurate (Source: https://doc.traefik.io/traefik/observability/metrics/opentelemetry/)

PR Checklist Review

Per CONTRIBUTING.md guidelines:

• ✅ Frontmatter complete (date, id, title, description, tags, doc_type)
• ✅ Redirects added for deleted pages (send-metrics.mdx, send-metrics-cloud.mdx, tutorials.mdx)
• ✅ Navigation updated in docsSideNav.ts
• ⚠️ Links need fixing: Several broken internal links (see inline comments)
• ✅ New component follows TypeScript best practices
• ✅ CONTRIBUTING.md updates are appropriate
• ✅ Cloud vs Self-Host admonition used correctly in traefik-observability.mdx

Recommendations

1. Fix the 5 broken links identified in inline comments
2. Consider adding a "Validate" section to the new send-metrics.mdx page to guide users on verifying their metrics are flowing
3. The new MetricsQuickStartOverview.tsx component is well-structured and provides good UX

Overall, this is a solid refactor that improves documentation structure. Once the broken links are fixed, this will be ready to merge.

---