Skip to content

Updated

Metrics API

Every Supabase project exposes a Prometheus-compatible Metrics API endpoint that surfaces ~200 Postgres performance and health series. You can scrape it into any observability stack to power custom dashboards, alerting rules, or long-term retention that goes beyond what Supabase Studio provides out of the box.

Chart a subset of the same window in Studio Reports. Use this page when you want the Prometheus-compatible scrape endpoint.

What you can do with the Metrics API

  • Stream database CPU, IO, WAL, connection, and query stats into Prometheus-compatible systems.
  • Combine Supabase metrics with application signals in Grafana, Datadog, or any other observability vendor.
  • For Grafana, you can use the Grafana Cloud integration in the Supabase Dashboard to get a configured instance and prebuilt dashboard in one click.
  • Reuse our supabase-grafana dashboard JSON to bootstrap over 200 ready-made charts.
  • Build your own alerting policies (right-sizing, saturation detection, index regression, and more).
What you can do with the Metrics API

Every Supabase project exposes a metrics feed at https://<project-ref>.supabase.co/customer/v1/privileged/metrics. Replace <project-ref> with the identifier from your project URL or from the dashboard sidebar.

  1. Copy your project reference and confirm the base URL using the helper below.
  1. Configure your collector to scrape once per minute. The endpoint already emits the full set of metrics on each request.
  2. Authenticate with HTTP Basic Auth:

To test locally, run curl with your Secret API key:

curl <project-url>/customer/v1/privileged/metrics \
--user 'service_role:sb_secret_...'

You can provision long-lived automation tokens in two ways:

# (Optional) Exchange an account access token for project API keys
export SUPABASE_ACCESS_TOKEN="your-access-token"
export PROJECT_REF="your-project-ref"
curl -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
"https://api.supabase.com/v1/projects/$PROJECT_REF/api-keys?reveal=true"

Choose your monitoring stack

Pick the workflow that best matches your tooling. Cards link to Supabase-authored guides or vendor integration docs, and some include a “Community” pill when there’s an accompanying vendor reference.

Grafana Cloud (SaaS)

Use Grafana Cloud’s managed Prometheus (works on Free + Pro tiers) and import the Supabase dashboard without running any infrastructure.
Supabase guide

Grafana + self-hosted Prometheus

Run Prometheus yourself following the official installation guidance and pair it with Grafana plus our dashboard JSON and alert pack.
Supabase guide

Datadog

Scrape the Metrics API with the Datadog Agent or Prometheus remote write and monitor Supabase alongside your app telemetry.
Community

Elastic

Use Elastic's managed Supabase integration to scrape metrics. The integration automatically installs dashboards, alert templates, and SLO templates as data arrives.
Community

Vendor-agnostic / BYO Prometheus

Connect AWS AMP, Grafana Mimir, VictoriaMetrics, or any Prometheus-compatible SaaS with the same scrape job pattern.
Supabase guide
Supabase Grafana dashboard showcasing database metrics

Additional resources