A complete PostgreSQL monitoring solution with automated performance analysis and reporting.

• Supports PostgreSQL versions 14-17

Create a new DB user in database to be monitored (skip this if you want just to check out postgres_ai monitoring with a synthetic demo database):

-- Create a user for Postgres AI monitoring
create user postgres_ai_mon with password '<password>';

grant connect on database <database_name> to postgres_ai_mon;

grant pg_monitor to postgres_ai_mon;
grant select on pg_stat_statements to postgres_ai_mon;
grant select on pg_stat_database to postgres_ai_mon;
grant select on pg_stat_user_tables to postgres_ai_mon;

-- Create a public view for pg_statistic access (required for bloat metrics on user schemas)
CREATE VIEW public.pg_statistic AS
SELECT 
    n.nspname as schemaname,
    c.relname as tablename,
    a.attname,
    s.stanullfrac as null_frac,
    s.stawidth as avg_width,
    false as inherited
FROM pg_statistic s
JOIN pg_class c ON c.oid = s.starelid
JOIN pg_namespace n ON n.oid = c.relnamespace  
JOIN pg_attribute a ON a.attrelid = s.starelid AND a.attnum = s.staattnum
WHERE a.attnum > 0 AND NOT a.attisdropped;

GRANT SELECT ON public.pg_statistic TO pg_monitor;
ALTER USER postgres_ai_mon set search_path = "$user", public, pg_catalog;

One command setup:

# Download the CLI
curl -o postgres_ai https://gitlab.com/postgres-ai/postgres_ai/-/raw/testing/postgres_ai \
  && chmod +x postgres_ai

Now, start it and wait for a few minutes. Two optional adjustments:

• remove --demo unless you want to see it in action without monitoring an actual Postgres DB (this option creates a demo DB)
• get an Postgres AI access token for your organization at https://console.postgres.ai (Your org name → Manage → Access tokens)

# Complete setup with demo database
./postgres_ai quickstart --demo

# Production setup with your API key
./postgres_ai quickstart --api-key=your_api_key

That's it! Everything is installed, configured, and running.

• Grafana Dashboards - Visual monitoring at http://localhost:3000
• PostgreSQL Monitoring - PGWatch with comprehensive metrics
• Automated Reports - Daily performance analysis
• API Integration - Automatic upload to PostgreSQL AI
• Demo Database - Ready-to-use test environment

For developers:

./postgres_ai quickstart --demo

Get a complete monitoring setup with demo data in under 2 minutes.

For production:

./postgres_ai quickstart --api-key=your_key
# Then add your databases
./postgres_ai add-instance "postgresql://user:pass@host:port/db"

For CI/CD:

./postgres_ai quickstart --demo --api-key=$API_KEY

Fully automated setup with no interactive prompts.

# Instance management
./postgres_ai add-instance "postgresql://user:pass@host:port/db"
./postgres_ai list-instances
./postgres_ai test-instance my-db

# Service management  
./postgres_ai status
./postgres_ai logs
./postgres_ai restart

# Health check
./postgres_ai health

After running quickstart:

• 🚀 MAIN: Grafana Dashboard: http://localhost:3000 (demouser/demopwd)

Technical URLs (for advanced users):

• Demo DB: postgresql://postgres:postgres@localhost:5432/target_database
• Monitoring: http://localhost:8080 (PGWatch)
• Metrics: http://localhost:9090 (Prometheus)

./postgres_ai help

Get your key at Postgres AI for automated report uploads and advanced analysis.