PG Exporter Documentation
Install, deploy, secure, operate, and extend pg_exporter.
PG Exporter collects PostgreSQL and PgBouncer metrics for Prometheus. These manuals describe v1.5.0.
Start here
- Introduction — How the exporter fits into your monitoring system.
- Quick start — Install the exporter and collect your first metrics.
- Download — Choose a package, binary archive, or container image.
Run in production
- Deployment — Run a service and connect Prometheus.
- Security — Configure database permissions, credentials, and TLS.
- Troubleshooting — Diagnose connection errors, missing metrics, and slow scrapes.
Configure the exporter
- Collector configuration — Define SQL queries, metrics, and collection settings.
- Bundled collectors — Find available metrics and their prerequisites.
- Command reference — Look up flags, environment variables, and defaults.
- HTTP API — Check health, inspect collection, and reload configuration.
- Compatibility — Check database versions, platforms, and architectures.
Development and releases
- Development — Build the exporter, change collectors, and run tests.
- Design records — Read architecture decisions and plans for unreleased features.
- Release notes — Find changes and artifacts for each version.
Open search with Ctrl with K on Windows/Linux or ⌘ with K on macOS.
Source code and issues are at pgsty/pg_exporter.