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!

Requirements:

✅ No agent required

🐧 Runs on Linux-based operating systems

🐘 Supports PostgreSQL version 13 or newer

🧩 Currently supports self-managed PostgreSQL instances only


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.

Let's run a health check

Getting started with pghealth