Debugging and monitoring
The Supabase CLI comes with a range of tools to help inspect your Postgres instances for potential issues. The CLI gets the information from Postgres internals. Therefore, most tools provided are compatible with any Postgres databases regardless if they are a Supabase project or not.
You can find installation instructions for the the Supabase CLI here.
inspect db command#
The inspection tools for your Postgres database are under then
inspect db command. You can get a full list of available commands by running
supabase inspect db help.
_12$ supabase inspect db help_12Tools to inspect your Supabase database_12_12Usage:_12supabase inspect db [command]_12_12Available Commands:_12bloat Estimates space allocated to a relation that is full of dead tuples_12blocking Show queries that are holding locks and the queries that are waiting for them to be released_12cache-hit Show cache hit rates for tables and indices_12_12...
Connect to any Postgres database#
Most inspection commands are Postgres agnostic. You can run inspection routines on any Postgres database even if it is not a Supabase project by providing a connection string via
For example you can connect to your local Postgres instance:
_10supabase --db-url postgresql://postgres:postgres@localhost:5432/postgres inspect db bloat
Connect to a Supabase instance#
Working with Supabase, you can link the Supabase CLI with your project:
_10supabase link --project-ref <project-id>
Then the CLI will automatically connect to your Supabase project whenever you are in the project folder and you no longer need to provide
Below are the db inspection commands provided, grouped by different use cases.
Some commands might require
pg_stat_statements to be enabled or a specific Postgres version to be used.
These commands are handy if you are running low on disk storage:
- bloat - estimates the amount of wasted space
- vacuum-stats - gives information on waste collection routines
- table-record-counts - estimates the number of records per table
- table-sizes - shows the sizes of tables
- index-sizes - shows the sizes of individual index
- table-index-sizes - shows the sizes of indexes for each table
The commands below are useful if your Postgres database consumes a lot of resources like CPU, RAM or Disk IO. You can also use them to investigate slow queries.
- cache-hit - shows how efficient your cache usage is overall
- unused-indexes - shows indexes with low index scans
- index-usage - shows information about the efficiency of indexes
- seq-scans - show number of sequential scans recorded against all tables
- long-running-queries - shows long running queries that are executing right now
- outliers - shows queries with high execution time but low call count and queries with high proportion of execution time spent on synchronous I/O
- locks - shows statements which have taken out an exclusive lock on a relation
- blocking - shows statements that are waiting for locks to be released
- role-connections - shows number of active connections for all database roles (Supabase-specific command)
- replication-slots - shows information about replication slots on the database
Following commands require
pg_stat_statements to be enabled: calls, locks, cache-hit, blocking, unused-indexes, index-usage, bloat, outliers, table-record-counts, replication-slots, seq-scans, vacuum-stats, long-running-queries.
pg_stat_statements also take note that it only stores the latest 5,000 statements. Moreover, consider resetting the analysis after optimizing any queries by running
Learn more about pg_stats here.
Supabase CLI's inspect commands are heavily inspired by the pg-extras tools.