How avamingli/pg_dash works
PG Dash is a Go backend and React dashboard for monitoring PostgreSQL and WarehousePG clusters. The principal workflow is: an operator opens a dashboard page, the frontend requests metrics or feature data from the backend, and the backend collects or queries PostgreSQL and host state before returning results; live metrics also arrive over WebSocket. The graph preserves documented query analysis, history, recommendations, alerts, cluster features, and plan watch/replay. Unsampled feature implementations are represented by their exact source directories; edges are limited to visible wiring or README-documented relationships.
Main entry points: aggregator.go Metrics Aggregator · main.go HTTP Server · handler API Handlers · pages Dashboard Pages
Components 25
Dashboard
- React App
frontend/src/App.tsx - Dashboard Pages
frontend/src/pages - API Client
frontend/src/lib/api.ts - Metrics Context
frontend/src/contexts/MetricsContext.tsx - WebSocket Hook
frontend/src/hooks/useWebSocket.ts - Live Plan Watch
frontend/src/components/QueryWatchPanel.tsx - Plan Viewer
frontend/src/components/PlanViewer.tsx - Plan Replay
frontend/src/lib/replayEngine.ts
API and Features
- HTTP Server
backend/cmd/server/main.go - API Handlers
backend/internal/handler - Connection Manager
backend/internal/service/connection.go
Monitoring
- Metrics Aggregator
backend/internal/monitor/aggregator.go - PG Collectors
backend/internal/monitor/pg - OS Collector
backend/internal/monitor/os/collector.go - Alert Engine
backend/internal/alert/engine.go - WebSocket Hub
backend/internal/ws/hub.go - Snapshot Store
backend/internal/service/snapshot.go
Query Analysis
- SQL Editor Endpoints
backend/internal/handler/query.go - Query Definitions
backend/internal/query - Query History
backend/internal/service/history.go - Health Scanner
backend/internal/recommend/scanner.go
Other components
- Operator
- PostgreSQL
- Host System
- Plan Extension
Connections 32
- Operator → React App: uses
- React App → Dashboard Pages: routes to
frontend/src/App.tsx - React App → Metrics Context: provides
frontend/src/App.tsx - Dashboard Pages → API Client: requests data
- API Client → HTTP Server: REST requests
- Metrics Context → WebSocket Hook: receives updates
- WebSocket Hook → HTTP Server: WebSocket
- Dashboard Pages → Live Plan Watch: offers watch
- Live Plan Watch → Plan Viewer: renders plans
frontend/src/components/QueryWatchPanel.tsx - Dashboard Pages → Plan Replay: replays runs
- HTTP Server → API Handlers: registers routes
backend/cmd/server/main.go - HTTP Server → Metrics Aggregator: starts collection
backend/cmd/server/main.go - HTTP Server → WebSocket Hub: creates hub
backend/cmd/server/main.go - API Handlers → Connection Manager: uses pools
backend/internal/handler/database.go - API Handlers → SQL Editor Endpoints: routes SQL
- SQL Editor Endpoints → Query Definitions: uses statements
backend/internal/handler/query.go - SQL Editor Endpoints → PostgreSQL: executes SQL
backend/internal/handler/query.go - Connection Manager → PostgreSQL: connects
- Metrics Aggregator → PG Collectors: collects metrics
backend/internal/monitor/aggregator.go - Metrics Aggregator → OS Collector: collects host stats
backend/internal/monitor/aggregator.go - PG Collectors → PostgreSQL: reads statistics
- OS Collector → Host System: reads resources
- Metrics Aggregator → Alert Engine: evaluates snapshots
backend/internal/monitor/aggregator.go - Metrics Aggregator → WebSocket Hub: broadcasts metrics
backend/internal/monitor/aggregator.go - Metrics Aggregator → Snapshot Store: records snapshots
- API Handlers → Health Scanner: exposes scans
- Health Scanner → Query Definitions: uses checks
backend/internal/recommend/scanner.go - Health Scanner → PostgreSQL: scans database
- Query History → PostgreSQL: stores history
backend/internal/service/history.go - API Handlers → Query History: serves history
- Plan Extension → Live Plan Watch: provides live plans
- Live Plan Watch → HTTP Server: watches queries