pgSentinelDocumentation
Complete guide to the professional pgbalancer management and monitoring platform. Real-time metrics, Prometheus integration, Grafana dashboards, and deep PostgreSQL analytics.
Documentation Sections
Everything you need to get started and master pgSentinel
Getting Started
Quick setup and first steps with pgSentinel
- Docker installation
- Configuration
- First dashboard
- Basic setup
Configuration
Complete configuration guide and options
- Environment variables
- Service configuration
- Database setup
- Custom settings
Dashboard Guide
Using the real-time monitoring dashboard
- Live metrics
- WebSocket updates
- Custom views
- Alert management
API Reference
Complete REST API documentation
- 25+ endpoints
- WebSocket API
- Authentication
- Examples
Grafana Integration
Setting up and using Grafana dashboards
- Pre-built dashboards
- Custom panels
- PromQL queries
- Alerting rules
Metrics Reference
Complete metrics and monitoring guide
- 30+ custom metrics
- Prometheus export
- System metrics
- pg_stat_insights
Troubleshooting
Common issues and solutions
- Common problems
- Debug guides
- Performance issues
- Log analysis
Key Features
Comprehensive monitoring and management capabilities
Real-Time Monitoring
Live dashboard with WebSocket updates every 5 seconds
- Interactive Next.js 14 dashboard with React 18
- WebSocket live updates for instant metric refresh
- Beautiful UI with Tailwind CSS and Recharts
- Real-time connection pool visualization
Prometheus Integration
30+ custom metrics with full PromQL support
- Custom metrics for pgbalancer performance
- System resource monitoring (CPU, memory, disk)
- PostgreSQL-specific metrics and insights
- Time-series data collection and storage
Grafana Dashboards
22 pre-built visualization panels
- Professional dashboards for system metrics
- pg_stat_insights visualization panels
- Configurable time ranges and queries
- Custom panel creation and sharing
pg_stat_insights
Deep PostgreSQL performance analytics
- Query performance analysis and optimization
- Table and index usage statistics
- Cache hit ratio monitoring
- Intelligent recommendations and alerts
REST API
25+ endpoints for programmatic control
- FastAPI backend with async support
- Comprehensive API documentation
- WebSocket support for real-time data
- Python and TypeScript client libraries
Docker Ready
8-service stack with one-command deployment
- Complete Docker Compose orchestration
- Production-ready container configuration
- Automatic health checks and restarts
- Volume persistence and network isolation
Architecture Overview
8-service Docker Compose stack for complete monitoring
Frontend Layer
Modern React-based user interfaces with real-time updates
Backend Layer
High-performance Python backend with async support
Monitoring Layer
Complete observability stack with metrics collection and visualization
Data Layer
Primary database with caching and performance extensions
Quick Start
Get pgSentinel running in minutes with Docker Compose
Ready to Get Started?
Explore the complete pgSentinel documentation and start monitoring your PostgreSQL infrastructure today.