2304c3ed12
- FastAPI application with OpenTelemetry instrumentation - Redis caching and Celery task processing - Docker Compose setup with monitoring stack - Grafana dashboards and Prometheus metrics - Jaeger distributed tracing - Comprehensive documentation in docs/ folder - Monitoring configuration and troubleshooting guides
2.9 KiB
2.9 KiB
DevServer Monitoring Framework Documentation
Welcome to the documentation for DevServer, a comprehensive framework designed for API monitoring and observability. DevServer integrates key technologies such as Redis, RabbitMQ, OpenTelemetry, Grafana, Prometheus, and Jaeger to provide a robust pipeline for tracking, analyzing, and troubleshooting distributed systems.
📚 Documentation Index
🚀 Quick Start & Reference
- QUICK_REFERENCE.md — Essential commands and setup instructions for DevServer
- MONITORING_GUIDE.md — Step-by-step guide to configuring monitoring and observability
🔧 Troubleshooting & Issues
- ISSUES_FIXED_AND_TROUBLESHOOTING.md — Common issues, resolutions, and troubleshooting strategies
- CONTAINER_ISSUES_RESOLVED.md — Solutions for containerization and deployment problems
📦 Deployment & Operations
- DEPLOYMENT_STATUS.md — Overview of deployment status and environment configuration
- DOCKER_CLEAN_REBUILD.md — Instructions for cleaning and rebuilding Docker containers
- MONITORING_COMPLETE.md — Monitoring system setup completion checklist
🏗️ Project Structure
DevServer/
├── docs/ # 📚 Documentation and guides
├── app/ # 🐍 FastAPI application for API endpoints
├── monitoring/ # 📊 Monitoring configs (Prometheus, Grafana, Jaeger)
├── logs/ # 📝 Centralized application logs
├── docker-compose.yml # 🐳 Multi-service orchestration (Redis, RabbitMQ, etc.)
├── Dockerfile # 🐳 Container build definition
└── pyproject.toml # 📦 Python dependencies and project metadata
🔗 Monitoring & Service Endpoints
- API Application: http://localhost:8000
- Grafana Dashboard: http://localhost:3000 (admin/admin)
- Jaeger Tracing: http://localhost:16686
- Prometheus Metrics: http://localhost:9090
- RabbitMQ Management: http://localhost:15672 (guest/guest)
- Redis: Accessible via configured port in
docker-compose.yml
🛠️ Framework Features
- Distributed Tracing: End-to-end request tracing with OpenTelemetry and Jaeger
- Metrics Collection: Real-time metrics via Prometheus
- Centralized Logging: Unified logs for all services
- Message Queue Monitoring: RabbitMQ integration for event-driven architectures
- Dashboard Visualization: Grafana dashboards for system health and performance
📞 Support
For help, consult the troubleshooting guide or review logs in the logs/ directory. For advanced monitoring or integration questions, refer to the relevant documentation in the docs/ folder.
Last updated: October 13, 2025