mirror of
https://github.com/supabase/supabase.git
synced 2026-10-16 06:39:09 +03:00
Chris Gwilliams
d55f6fb780
* add genera deployment instructions for both grafana and prometheus * add supabase-grafana to spellchecks
116 lines
5.1 KiB
Plaintext
116 lines
5.1 KiB
Plaintext
---
|
|
id: 'metrics'
|
|
title: 'Metrics'
|
|
description: 'Observability for your Supabase project'
|
|
---
|
|
|
|
In addition to the reports and charts built in to the Supabase dashboard, each project hosted on the Supabase platform comes with a [Prometheus](https://prometheus.io/)-compatible metrics endpoint, updated every minute, 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.
|
|
|
|
<Admonition type="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.
|
|
|
|
</Admonition>
|
|
|
|
<Admonition type="note">
|
|
|
|
The endpoint discussed in this article is not available on self-hosted.
|
|
|
|
</Admonition>
|
|
|
|
## 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.
|
|
|
|
```shell
|
|
> curl https://<project-ref>.supabase.co/customer/v1/privileged/metrics --user 'service_role:<service-role-jwt>'
|
|
```
|
|
|
|
## Supabase Grafana
|
|
|
|
The pre-configured Supabase Grafana Dashboard is an advanced version of the [Dashboard's Database Reports](https://supabase.com/dashboard/project/_/reports/database). It visualizes over 200 database performance and health metrics.
|
|
|
|
|
|
|
|
Instructions are included in the README for deploying the repository using docker.
|
|
|
|
## Using the metrics endpoint in production
|
|
|
|
To set up monitoring for your project, you will need two things:
|
|
|
|
1. A datastore - a place to store the metrics coming from your Supabase project over time
|
|
2. A dashboard - a place to visualize the state of your Supabase project for a defined period
|
|
|
|
### Setting up a metrics datastore
|
|
|
|
One of the more well-known options is [Prometheus](https://prometheus.io/docs/introduction/overview/) and it is the tool used in this guide.
|
|
|
|
You can [self-host](https://prometheus.io/docs/prometheus/latest/installation/) Prometheus or choose a managed service to store your metrics. Some of the providers offering managed Prometheus are:
|
|
|
|
- [Digital Ocean](https://marketplace.digitalocean.com/apps/prometheus)
|
|
- [AWS](https://aws.amazon.com/prometheus/)
|
|
- [Grafana Cloud](https://grafana.com/products/cloud/metrics/)
|
|
|
|
Follow the guides for the deployment option you choose
|
|
|
|
#### Adding a scrape job to Prometheus
|
|
|
|
For Prometheus, modify your `prometheus.yaml` file to add a Supabase job, and set the `metrics_path`, `scheme`, `basic_auth` and `targets` parameters. For example:
|
|
|
|
```yaml
|
|
scrape_configs:
|
|
- job_name: "MySupabaseJob"
|
|
metrics_path: "/customer/v1/privileged/metrics"
|
|
scheme: https
|
|
basic_auth:
|
|
username: "service_role"
|
|
password: "<your service_role JWT>"
|
|
static_configs:
|
|
- targets: [
|
|
"<your Supabase Project ID>.supabase.co:443"
|
|
]
|
|
labels:
|
|
group: "MyGroupLabel"
|
|
```
|
|
|
|
### Setting up a dashboard
|
|
|
|
For this guide, we will be using [Grafana](https://grafana.com/docs/grafana/latest/introduction/).
|
|
|
|
You can [self-host](https://grafana.com/docs/grafana/latest/setup-grafana/installation/) Grafana or many providers offer managed Grafana, some of which are listed below:
|
|
|
|
- [DigitalOcean](https://marketplace.digitalocean.com/apps/grafana)
|
|
- [AWS](https://aws.amazon.com/grafana/)
|
|
- [Grafana Cloud](https://grafana.com/grafana/)
|
|
|
|
Follow the guides of the provider you choose to get Grafana up and running.
|
|
|
|
### Adding a data source to Grafana
|
|
|
|
In the left-hand menu, select `Data sources` and click `Add new data source`.
|
|
|
|
Select `Prometheus` and enter the connection details for the Prometheus instance you have set up.
|
|
|
|
Under **Interval behavior**, set the **scraping interval** to 60s and test the data source. Once it has passed, save it.
|
|
|
|
### Adding the Supabase dashboard
|
|
|
|
In the left-hand menu, select `Dashboards` and click `New`. From the drop-down, select `Import`.
|
|
|
|
Copy the raw file from our [supabase-grafana](https://raw.githubusercontent.com/supabase/supabase-grafana/refs/heads/main/grafana/dashboard.json) repository and paste it (or upload the file).
|
|
|
|
Click `Load` and the dashboard will load from the project specified in your Prometheus job.
|
|
|
|
### Monitoring your project
|
|
|
|
You can configure alerts from Prometheus or Grafana. The `supabase-grafana` repository has a selection of [example alerts](https://github.com/supabase/supabase-grafana/blob/main/docs/example-alerts.md) that can be configured.
|
|
|
|
<Admonition type="caution">
|
|
Grafana Cloud has an unofficial integration for scraping Supabase metrics. See their
|
|
[docs](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-supabase/)
|
|
for instructions on how to configure it but note that it is not full-featured nor is it supported
|
|
by Supabase.
|
|
</Admonition>
|