Zuvo Docs

Guide

Metrics API

Export Zuvo database metrics to any Prometheus-compatible tool

Every Zuvo 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 Zuvo Studio provides out of the box.

What you can do with the Metrics API

  • Stream database CPU, IO, WAL, connection, and query stats into Prometheus-compatible systems.
  • Combine Zuvo metrics with application signals in Grafana, Datadog, or any other observability vendor.
  • 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).

Every Zuvo 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.

  2. Configure your collector to scrape once per minute. The endpoint already emits the full set of metrics on each request.

  3. 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.zuvodev.com/v1/projects/$PROJECT_REF/api-keys?reveal=true"

Choose your monitoring stack

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

Zuvo Grafana dashboard showcasing database metrics

Additional resources