Skip to content

Conversation

@Calm-Rock
Copy link
Contributor

@Calm-Rock Calm-Rock commented Aug 13, 2025

Description

This PR adds comprehensive documentation for three important dashboard templates: HTTP API Monitoring, ArgoCD Dashboard, and AWS ElastiCache Redis under the dashboard templates section.

Changes Made

HTTP API Monitoring Dashboard

  • ✅ Added http-api-monitoring.mdx documentation file
  • ✅ Comprehensive documentation covering all dashboard widgets and metrics
  • ✅ Detailed explanations of use cases and monitoring capabilities
  • ✅ Built on OpenTelemetry HTTP attributes for standardized monitoring

ArgoCD Dashboard

  • ✅ Added argocd-dashboard.mdx documentation file
  • ✅ Complete coverage of ArgoCD application and operations monitoring
  • ✅ Detailed breakdown of all monitoring sections and metrics
  • ✅ Covers GitOps workflows and deployment monitoring

AWS ElastiCache Redis Dashboard

  • ✅ Added aws-elasticache-redis.mdx documentation file
  • ✅ Comprehensive AWS CloudWatch metrics monitoring
  • ✅ Complete coverage of Redis cache performance and infrastructure metrics
  • ✅ Monitoring best practices and alerting recommendations

Component Updates

  • ✅ Updated APMDashboardsListicle.tsx to link HTTP API Monitoring to documentation page
  • ✅ Fixed Database Calls Monitoring link for consistency
  • ✅ Updated DashboardTemplatesListicle.tsx to link ArgoCD to documentation page
  • ✅ Updated DashboardTemplatesListicle.tsx to link AWS ElastiCache Redis to documentation page

Dashboard Features Documented

HTTP API Monitoring Dashboard

  • Top HTTP Endpoints: Table showing busiest API endpoints with count and average duration
  • HTTP Status Code Distribution: Time-series graph of status code patterns by route
  • External HTTP APIs: Monitoring of outbound API calls with performance metrics
  • HTTP Endpoint Latency - P90: 90th percentile response times over time
  • Slowest HTTP Calls: Real-time list of slowest requests for quick identification

ArgoCD Dashboard

  • Application Health Metrics: Healthy, Progressing, Suspended, Degraded counters
  • Sync Status Tracking: Synced vs OutOfSync application monitoring
  • Controller Performance: Sync activity, reconciliation metrics, workqueue depth
  • Cluster Statistics: Resource objects, API activity, cache metrics
  • Repository Activity: Git fetch and ls-remote request monitoring

AWS ElastiCache Redis Dashboard

  • CPU Performance: Host and engine CPU utilization monitoring
  • Memory Management: Usage percentages, fragmentation ratio, freeable memory
  • Cache Performance: Hit rates, evictions, and cache efficiency metrics
  • Network Activity: Inbound and outbound traffic monitoring
  • Replication Health: Lag monitoring and connection tracking
  • System Metrics: Swap usage and capacity planning insights

Structure & Benefits

  • Follows existing documentation patterns and formatting
  • Includes dashboard preview sections with import functionality
  • Comprehensive metrics explanations with filtering variables
  • Cross-references to related dashboards
  • Provides teams with detailed monitoring guidance
  • Best practices and alerting recommendations

Related Files

  • References dashboard JSONs at:
    • https://raw.githubusercontent.com/SigNoz/dashboards/refs/heads/main/apm/http-api-monitoring.json
    • https://raw.githubusercontent.com/SigNoz/dashboards/refs/heads/main/argocd/argocd.json
    • https://raw.githubusercontent.com/SigNoz/dashboards/refs/heads/main/aws-elasticache/redis/overview.json

The documentation enables teams to effectively monitor HTTP API performance, ArgoCD GitOps workflows, and AWS ElastiCache Redis instances with comprehensive observability and optimization guidance.

- Add comprehensive documentation for HTTP API Monitoring dashboard
- Include detailed descriptions of all metrics and use cases
- Follow existing documentation structure and formatting
- Built on OpenTelemetry HTTP attributes for standardized monitoring
@vercel
Copy link

vercel bot commented Aug 13, 2025

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

Project Deployment Preview Comments Updated (UTC)
signoz-web Ready Preview Comment Aug 13, 2025 6:06pm

…lder

- Remove use cases section as requested
- Remove best practices section as requested  
- Remove dashboard image placeholder since image is not available
- Keep core metrics documentation and related dashboards section
- Update HTTP API Monitoring href to point to new documentation page
- Fix Database Calls Monitoring href to point to documentation page for consistency
- All APM dashboards now link to their respective documentation pages
- Add comprehensive documentation for ArgoCD monitoring dashboard
- Include detailed descriptions of all monitoring sections and metrics
- Cover application health, sync status, controller stats, cluster stats, and repo server metrics
- Follow existing documentation structure and formatting
- Provide filtering variables and related dashboards
- Update ArgoCD href from GitHub repository to documentation page
- Point to /docs/dashboards/dashboard-templates/argocd-dashboard
- Maintain consistency with other documented dashboard templates
@Calm-Rock Calm-Rock changed the title feat: add HTTP API Monitoring dashboard documentation feat: add HTTP API Monitoring and ArgoCD dashboard documentation Aug 13, 2025
- Add comprehensive documentation for AWS ElastiCache Redis monitoring dashboard
- Include detailed descriptions of all CloudWatch metrics and widgets
- Cover CPU, memory, network, cache performance, and replication metrics
- Provide monitoring best practices and alerting recommendations
- Follow existing documentation structure and formatting
- Update AWS ElastiCache Redis href from GitHub repository to documentation page
- Point to /docs/dashboards/dashboard-templates/aws-elasticache-redis
- Maintain consistency with other documented dashboard templates
@Calm-Rock Calm-Rock changed the title feat: add HTTP API Monitoring and ArgoCD dashboard documentation feat: add HTTP API Monitoring, ArgoCD, and AWS ElastiCache Redis dashboard documentation Aug 13, 2025
- Add comprehensive documentation for AWS SQS Prometheus monitoring dashboard
- Include detailed descriptions of queue message state metrics and monitoring
- Cover visible, delayed, and in-flight message tracking with third-party exporter
- Provide setup guidance for SQS Prometheus exporter integration
- Include monitoring best practices and alerting recommendations
- Follow existing documentation structure and formatting
@makeavish makeavish merged commit da8a747 into SigNoz:main Oct 20, 2025
2 checks passed
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.

2 participants