DECLARATIVE POSTGRESQL METRICS EXPORTER

pg_exporter

PostgreSQL observability, expressed in SQL.Declarative collectors · dynamic planning · native Prometheus metrics

One binary plus YAML and SQL covers PostgreSQL 10–19+ and PgBouncer 1.8–1.25+, selecting query branches by server version, role, and installed extensions.

Get Started Documentation

$ PG_EXPORTER_URL='postgres://monitor@localhost/postgres' pg_exporter

CURRENT SURFACE

Useful by Default, Precise When Customized

600+Metric Families 58Collector Files 10-19+PostgreSQL 35Documented Tags

QUICK START

Connect, Start, Scrape

Install v1.4.1 for your platform, then verify the complete database-to-Prometheus path in three actions.

1Install the binary

sudo apt install -y pg-exporter

2Connect and run

PG_EXPORTER_URL='postgres://monitor@localhost/postgres' pg_exporter

3Verify metrics

curl -fsS localhost:9630/metrics

WHY PG EXPORTER

Make SQL the Observability Interface

Collector logic lives in configuration; the runtime handles discovery, planning, caching, timeouts, and Prometheus encoding.

DECLARATIVE

YAML + SQL

Add or revise metrics without changing Go code
Declare GAUGE, COUNTER, HISTOGRAM, and LABEL mappings
Control cost with TTL and per-collector timeouts

DYNAMIC PLAN

Plan for the Target

Match version, recovery role, database, and user
Check extensions, schemas, and custom predicates
Explain every planning verdict through /explain

OPERATING MODEL

Clear Boundaries from Connection to Series

01 · PLAN

Discover the Target, Build a Plan

Connect to PostgreSQL or PgBouncer
Read version, role, extension, and schema facts
Select one compatible branch for each collector

exporter.http

GET /metrics  # Prometheus scrape
GET /explain  # collector plan
GET /stat     # runtime statistics
POST /-/reload # reload config

02 · COLLECT

Execute Concurrently, Encode Consistently

Default collectors cover identity, replication, WAL, I/O, locks, and relations
A non-fatal collector failure preserves other successful results
Exporter self-metrics and database metrics remain distinct

collector.yml

pg_example:
  query: SELECT value FROM view
  min_version: 100000
  tags: [cluster, primary]
  ttl: 10
  timeout: 0.1

v1.4.1

Choose the Artifact for Your Runtime

Linux, macOS, and Windows archives; RPM and DEB packages; amd64 and arm64 Docker images.

PACKAGES

RPM / DEB

Includes a systemd unit, default environment file, and merged configuration for service deployments.

amd64arm64ppc64le

Install guide

RELEASE

v1.4.1

Get platform archives and packages from GitHub Releases and review the exact version notes.

LinuxmacOSWindowsDocker

View release artifacts

Start the tutorial All 35 versions