Basira Documentation
Database monitoring for PostgreSQL and ClickHouse.
Welcome to the Basira documentation. Basira monitors PostgreSQL and ClickHouse — query performance, active sessions, table health, replication, and engine-specific internals.
Getting Started
- Quickstart — Go from signup to monitoring in under 5 minutes
- Authentication — API keys, JWT tokens, and account verification
Agent Setup
- Agent Installation — Deploy the Basira agent with Helm
- Agent Configuration — Configure the agent for one or more databases
- Advanced Agent Config — Environment variables, buffering, and additional options
- Collector Reference — All collectors, intervals, and what they collect
Database Setup
- PostgreSQL Setup — Create monitoring user, enable pg_stat_statements
- ClickHouse Setup — Create monitoring user, verify query_log
Using the Dashboard
- Dashboard Overview — Health score and key metrics explained
- Query Performance — Find and fix slow queries
- Active Queries — Real-time monitoring, locks, and wait events
- Tables & Indexes — Table health, unused indexes
- Health Diagnosis — Automated health checks and remediation
Engine-Specific Guides
- Replication Monitoring — Lag, replica status, and slots (PostgreSQL)
- PostgreSQL Advanced — I/O stats, background writer, WAL, wait events
- ClickHouse Monitoring — Parts, merges, mutations, server metrics
API & Reference
- API Reference — Complete REST API documentation
- Rate Limiting — Auth endpoint limits
- Troubleshooting — Common issues and solutions