Install PGVitals Agent

Prerequisites

• PostgreSQL 12+ with pg_stat_statements extension enabled
• A PGVitals account and API key (get one at signup)

1. Enable pg_stat_statements

Add to your postgresql.conf or run:

sqlCREATE EXTENSION IF NOT EXISTS pg_stat_statements;

On RDS: modify the parameter group to set shared_preload_libraries = pg_stat_statements and reboot.

2. Install the agent

Docker (recommended)

bashdocker run -d \
  -e PGVITALS_DATABASE_URL="postgres://user:pass@host:5432/dbname" \
  -e PGVITALS_API_KEY="pgp_live_your_key_here" \
  --name pgvitals-agent \
  kalpitpant/pgvital-agent:latest

3. Configure and run

bashexport PGVITALS_DATABASE_URL="postgres://user:pass@host:5432/dbname"
export PGVITALS_API_KEY="pgp_live_your_key_here"

# Optional
export PGVITALS_INTERVAL="5m"        # Collection interval (default: 5m)
export PGVITALS_HOSTNAME="prod-db-01" # Label for this instance

pgvitals-agent

4. Verify

After starting the agent, check your dashboard — the instance should appear within 1 minute. You'll receive your first digest email right away to confirm everything is working, then weekly every Monday at 9am UTC.

Environment variables