AI & Agent Dev Bug Sandbox logo
AI & Agent Dev Bug Sandbox
Back to Radar

Fix Deprecated And Broken Links In Supabase Observability/Inspect Documentation

The observability/inspect documentation page contains a Query performance section with multiple broken links and lists several deprecated Supabase CLI inspect subcommands. This misleads users into using outdated commands and leads to dead links. The fix updates the section to reflect the current CLI subcommands, removes deprecated entries from the main list, and adds a deprecation notice.

mediumConfidence 85%Supabase

Origin Analysis

The documentation was not updated when the Supabase CLI deprecated several `inspect db` subcommands and removed or renamed their corresponding documentation anchors, resulting in broken links and references to obsolete commands.
1. Visit https://supabase.com/docs/guides/observability/inspect#query-performance 2. Observe that multiple hyperlinks in the list are broken (e.g., links to deprecated commands like cache-hit, index-usage, table-sizes, etc.) 3. Run `supabase inspect db --help` and compare the available subcommands with those listed on the page; note that many listed commands are marked as deprecated.

Fixing Code Block

### Query performance Use the following commands to inspect query performance: - [db-stats](#db-stats): Show database stats. - [replication-slots](#replication-slots): Show replication slots. - [locks](#locks): Show exclusive locks. - [blocking](#blocking): Show blocking queries. - [outliers](#outliers): Show query outliers by time. - [calls](#calls): Show queries by call count. - [index-stats](#index-stats): Show index stats. - [long-running-queries](#long-running-queries): Show long-running queries. - [bloat](#bloat): Show relation bloat. - [role-stats](#role-stats): Show role stats. - [vacuum-stats](#vacuum-stats): Show vacuum stats. - [table-stats](#table-stats): Show table stats. - [traffic-profile](#traffic-profile): Show traffic profile. The following commands are deprecated and should no longer be used: - `cache-hit` - `index-usage` - `total-index-size` - `index-sizes` - `table-sizes` - `table-index-sizes` - `total-table-sizes` - `unused-indexes` - `table-record-counts` - `seq-scans` - `role-configs` Use the equivalent non-deprecated commands listed above instead.
The updated section replaces the outdated command list with the current `supabase inspect db` subcommands, removes deprecated commands from the active list, and adds a clear deprecation notice. Link anchors are updated to point to the correct sections on the same page, assuming each command has a corresponding anchor.

Edge Case Audit

The anchor links assume that the inspect page includes sections for each listed command. If those sections do not exist, the anchors will be broken. Before applying, verify that each anchor has a matching heading in the markdown file. Also, CLI commands may change in future Supabase versions; a periodic review of this documentation is recommended. Rollback: replace the section with the previous version or revert the commit if new broken links are introduced.

Ecosystem Topology