Getting Started

Getting started with the pghealth

pghealth is a health check tool that allows you to instantly view the health status of your PostgreSQL database.

The overall health is represented as a percentage, based on a collection of scored metrics.

Each metric includes a clear explanation and its individual score, along with actionable recommendations on how to improve it.

Getting started with pghealth is pretty simple β€” just install the required extensions and connect your database. If you're ready, let's get started!

πŸŽ₯ Installation Video

Requirements:

Before installing pghealth, please ensure your environment meets the following requirements:

βœ… Agent-free architecture – No local monitoring agent installation required.

πŸ”Œ Requires specific PostgreSQL extensions (see the Installing Extensions section).

🐧 The database host must run on a Linux-based operating system.

🐘 Supported versions: PostgreSQL 13, 14, 15, 16, 17, 18

🧩 Currently supports self-managed PostgreSQL instances only. Managed database services (e.g., AWS RDS, Google Cloud SQL, Azure Database for PostgreSQL) are not yet supported.


Installing Extensions

Learn how to install extentions on your PostgreSQL instance

Enabling pg_stat_statements

Learn how to enable pg_stat_statements and add it to shared_preload_libraries.

Enabling logging_collector

Learn how to enable logging_collector and configure PostgreSQL logging settings.

Enabling Query Advisor AI

Learn how to enable and configure Query Advisor AI for PostgreSQL to get automated insights on slow or inefficient queries.

Let's run a health check

Getting started with pghealth