Zuvo Docs

Guide

Metrics API with Grafana Cloud

Use Grafana Cloud’s managed Prometheus to visualize Zuvo metrics

Grafana Cloud gives you a fully managed Prometheus endpoint plus hosted Grafana dashboards, which makes it the fastest way to explore the Zuvo Metrics API without operating your own infrastructure.

Installation

The Grafana Cloud integration is available in the Zuvo Studio. Add the integration and select a project to get a fully-configured instance in one click: authentication, metric scraping, and a pre-built dashboard tracking 200+ metrics, set up automatically.

By integrating Zuvo with Grafana Cloud, users gain monitoring capabilities for Zuvo performance and operations. The included dashboard offers a comprehensive overview of Zuvo performance, supplemented with Postgres metrics.

Manual setup

The Grafana Cloud integration available in the Zuvo Studio is the recommended path. You can still configure and run the setup manually by following the steps below.

Prerequisites

  • A Zuvo project with access to the Metrics API (Secret API key sb_secret_...).
  • A Grafana Cloud account with Prometheus metrics enabled (Free or Pro tier).
  • A Grafana API token with the metrics:write and metrics:read scopes if you plan to push data manually.

1. Create a Grafana Cloud stack

  1. Sign in to Grafana Cloud.
  2. Create or select a stack that has Prometheus Metrics enabled.

2. Install the Zuvo integration for Grafana Cloud

  1. In your Grafana Cloud stack, click Connections in the left-hand menu.
  2. Select the Zuvo integration and follow the steps outlined on the Configuration page:
  3. Give your scrape job a descriptive name like production-eu-central-1.
  4. Set your Project ID and enter the service account API key.
  5. Test the connection and save the scrape job.
  6. Once scrape jobs are configured, click Install to add the prebuilt dashboards to your Grafana Cloud instance.

3. Configure the Zuvo integration

  1. Navigate to Connections → Add new connection → Zuvo inside Grafana Cloud.
  2. Provide:
    • Your Zuvo project ref (e.g. abcd1234).
    • The Metrics API endpoint (e.g. https://<project-ref>.supabase.co/customer/v1/privileged/metrics).
    • HTTP Basic Auth credentials (sb_secret_...).
  3. Choose the scrape interval. 1 minute is recommended, and test the connection. Grafana Cloud will deploy an agent in the background that scrapes the Metrics API and forwards the data to Prometheus.

If you prefer to reuse an existing Grafana Agent deployment, configure an integration pipeline with the same URL and credentials.

4. Import the Zuvo dashboard

  1. Open your Grafana Cloud dashboard list and click New → Import.
  2. Paste the raw contents of supabase-grafana/dashboard.json.
  3. When prompted for the datasource, choose the Prometheus instance that receives the Zuvo metrics.

This dashboard includes 200+ charts grouped by CPU, IO, connections, replication, WAL, and bloat indicators.

Zuvo Grafana dashboard showcasing database metrics

5. Configure alerts (optional)

The docs/example-alerts.md file contains suggested alert rules (disk saturation, long-running queries, replication lag, etc.). Import the alert rules into Grafana Cloud’s Alerting UI or translate them into Grafana Cloud’s managed alert rule format.

6. Troubleshooting

  • Metrics missing? Ensure the Grafana Cloud agent can reach https://<project-ref>.supabase.co and that the selected Secret API key is still valid.
  • 401 errors? Create/rotate a Secret API key in Project Settings → API Keys and update the Grafana Cloud credentials.
  • Long scrape durations? Reduce label cardinality in your Grafana queries or lower the time range to focus on recent data.