Skip to main content

Metrics

In addition to the reports and charts built in to the Supabase dashboard, each project hosted on the Supabase platform comes with a Prometheus-compatible metrics endpoint, which can be used to gather insight into the health and status of your project.

You can use this endpoint to ingest data into your own monitoring and alerting infrastructure, as long as it is capable of scraping Prometheus-compatible endpoints, in order to set up custom rules beyond those supported by the Supabase dashboard.

note

The endpoint discussed in this article is in beta, and the metrics returned by it might evolve or be changed in the future to increase its utility.

note

The endpoint discussed in this article is an Enterprise feature and is not available on self-hosted. It is available for all projects until 1st Sept 2022, and then will be disabled for Free-tier and Pro-tier projects.

Accessing the metrics endpoint

Your project's metrics endpoint is accessible at https://<project-ref>.supabase.co/customer/v1/privileged/metrics. Access to the endpoint is secured via HTTP Basic Auth; the username is service_role, while the password is the service role JWT available through the Supabase dashboard.

> curl https://<project-ref>.supabase.co/customer/v1/privileged/metrics --user 'service_role:<service-role-jwt>'

Additionally, we maintain a guide on quickly setting up a scraping agent to work with Grafana Cloud.