Skip to content

Improve send-metrics-cloud documentation with custom metrics, K8s config, and Metrics Explorer #1706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Calm-Rock
Copy link
Member

This PR addresses the feedback from https://github.com/SigNoz/engineering-pod/issues/1980#issuecomment-2918238402

Changes Made

✅ Custom Metrics from Applications

  • Added comprehensive section on sending custom metrics directly from applications
  • Included code examples for Python, Node.js, and Java applications
  • Provided step-by-step installation and configuration instructions
  • Added validation steps to verify metrics ingestion

✅ Kubernetes Prometheus Receiver Configuration

  • Added detailed Kubernetes-specific configuration for Prometheus receiver
  • Included ConfigMap and DaemonSet deployment examples
  • Added configurations for scraping Kubernetes API server, node, and pod metrics
  • Provided resource detection and proper labeling for Kubernetes environments

✅ Document Structure Similar to Traces Documentation

  • Restructured the document to follow the same pattern as the traces documentation
  • Added clear overview section with multiple methods to send metrics
  • Organized content with proper sections and subsections
  • Improved readability and navigation

✅ Metrics Explorer Section

  • Added detailed "Viewing Your Metrics in SigNoz" section
  • Explained how to navigate to and use the Metrics Explorer
  • Provided guidance on searching, filtering, and visualizing metrics
  • Included information about creating dashboards from metrics

✅ Additional Improvements

  • Added troubleshooting section for common issues
  • Included network connectivity testing commands
  • Added information about different types of metrics available
  • Improved code examples with proper syntax highlighting
  • Added references to SigNoz Cloud regions and ingestion keys

Before vs After

Before: The documentation only covered OpenTelemetry Collector configuration and lacked comprehensive coverage of custom metrics, Kubernetes specifics, and viewing metrics in SigNoz.

After: The documentation now provides a complete guide covering all methods to send metrics to SigNoz Cloud, includes Kubernetes-specific configurations, and provides detailed guidance on viewing and troubleshooting metrics.

Testing

  • ✅ Validated that all code examples use correct OpenTelemetry SDK versions
  • ✅ Confirmed Kubernetes YAML configurations follow best practices
  • ✅ Verified all internal links and references are correct
  • ✅ Ensured the document structure matches the traces documentation pattern

This improvement makes the metrics documentation much more comprehensive and user-friendly, addressing all the points raised in the original feedback.

This commit addresses the feedback from SigNoz/engineering-pod#1980 (comment)

Key improvements:
- Added comprehensive section on sending custom metrics directly from applications
- Included Kubernetes-specific configuration for Prometheus receiver
- Restructured document to follow similar pattern as the traces documentation
- Added detailed "Viewing Your Metrics in SigNoz" section mentioning Metrics Explorer
- Added troubleshooting section for common issues
- Included code examples for Python, Node.js, and Java applications
- Added step-by-step validation instructions

The document now covers:
✅ Custom metrics from applications
✅ Kubernetes Prometheus receiver configuration  
✅ Structure similar to traces documentation
✅ Metrics Explorer for viewing metrics
✅ Comprehensive examples and troubleshooting
Copy link

vercel bot commented Jul 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
signoz-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 20, 2025 2:34pm

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.

1 participant