mirror of
https://github.com/supabase/supabase.git
synced 2026-06-18 21:54:18 +08:00
ebcd052018
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs update (stale internal links / dead anchors). ## What is the current behavior? The Metrics guide moved from `/docs/guides/platform/metrics` to `/docs/guides/telemetry/metrics` and was split into sub-pages, but 15 internal links across the docs still use the old path: 1. **Redirect chain** — non-anchored links to `/docs/guides/platform/metrics` only resolve via a two-hop permanent redirect (`platform/metrics` → `monitoring-troubleshooting/metrics` → `telemetry/metrics`, in `apps/www/lib/redirects.js`). 2. **Dead anchors** — `#accessing-the-metrics-endpoint` and `#deploying-supabase-grafana` no longer exist on the restructured page, so those links currently land at the top of the page instead of the intended section. ## What is the new behavior? - Non-anchored links now point directly at the canonical `/docs/guides/telemetry/metrics` (relative links use `../telemetry/metrics`), avoiding the redirect chain. - `#accessing-the-metrics-endpoint` links → `/docs/guides/telemetry/metrics` (the Metrics API endpoint access content lives on that page). - `#deploying-supabase-grafana` links → `/docs/guides/telemetry/metrics/grafana-self-hosted`, the page that now holds the Prometheus/Grafana installation instructions those links referenced. 15 files changed, links only — no content changes. ## Additional context Pure documentation link cleanup. Affected files include several guides (`database/connection-management`, `database/inspect`, `platform/performance`, `platform/read-replicas`) and troubleshooting entries that reference the Metrics/Grafana setup guide.
108 lines
5.4 KiB
Plaintext
108 lines
5.4 KiB
Plaintext
---
|
|
id: 'connection-management'
|
|
title: 'Connection management'
|
|
description: 'Managing connections'
|
|
subtitle: 'Using your connections resourcefully'
|
|
---
|
|
|
|
## Connections
|
|
|
|
Every [Compute Add-On](/docs/guides/platform/compute-add-ons) has a pre-configured direct connection count and Supavisor pool size. This guide discusses ways to observe and manage them resourcefully.
|
|
|
|
### Configuring Supavisor's pool size
|
|
|
|
You can change how many database connections Supavisor can manage by altering the pool size in the "Connection pooling" section of the [Database Settings](/dashboard/project/_/database/settings):
|
|
|
|
|
|
|
|
The general rule is that if you are heavily using the PostgREST database API, you should be conscientious about raising your pool size past 40% of the Database Max Connections. Otherwise, you can commit 80% to the pool. This leaves adequate room for the Authentication server and other utilities.
|
|
|
|
These numbers are generalizations and depends on other Supabase products that you use and the extent of their usage. The actual values depend on your concurrent peak connection usage. For instance, if you were only using 80 connections in a week period and your database max connections is set to 500, then realistically you could allocate the difference of 420 (minus a reasonable buffer) to service more demand.
|
|
|
|
## Monitoring connections
|
|
|
|
### Capturing historical usage
|
|
|
|
#### Dashboard monitoring charts
|
|
|
|
<Image
|
|
alt="Database client connections chart"
|
|
|
|
src={{
|
|
dark: '/docs/img/database/reports/db-connections-chart-dark.png',
|
|
light: '/docs/img/database/reports/db-connections-chart-light.png',
|
|
}}
|
|
width={2062}
|
|
height={608}
|
|
/>
|
|
|
|
For Teams and Enterprise plans, Supabase provides Advanced Telemetry charts directly within the Dashboard. The `Database client connections` chart displays historical connection data broken down by connection type:
|
|
|
|
- **Postgres**: Direct connections from your application
|
|
- **PostgREST**: Connections from the PostgREST API layer
|
|
- **Reserved**: Administrative connections for Supabase services
|
|
- **Auth**: Connections from Supabase Auth service
|
|
- **Storage**: Connections from Supabase Storage service
|
|
- **Other roles**: Miscellaneous database connections
|
|
|
|
This chart helps you monitor connection pool usage, identify connection leaks, and plan capacity. It also shows a reference line for your compute size's maximum connection limit.
|
|
|
|
For more details on using these monitoring charts, see the [Reports guide](/docs/guides/telemetry/reports#advanced-telemetry).
|
|
|
|
#### Grafana Dashboard
|
|
|
|
Supabase offers a Grafana Dashboard that records and visualizes over 200 project metrics, including connections. For setup instructions, check the [metrics docs](/docs/guides/telemetry/metrics).
|
|
|
|
Its "Client Connections" graph displays connections for both Supavisor and Postgres
|
|
|
|
|
|
### Observing live connections
|
|
|
|
`pg_stat_activity` is a special view that keeps track of processes being run by your database, including live connections. It's particularly useful for determining if idle clients are hogging connection slots.
|
|
|
|
Query to get all live connections:
|
|
|
|
```sql
|
|
SELECT
|
|
pg_stat_activity.pid as connection_id,
|
|
ssl,
|
|
datname as database,
|
|
usename as connected_role,
|
|
application_name,
|
|
client_addr as IP,
|
|
query,
|
|
query_start,
|
|
state,
|
|
backend_start
|
|
FROM pg_stat_ssl
|
|
JOIN pg_stat_activity
|
|
ON pg_stat_ssl.pid = pg_stat_activity.pid;
|
|
```
|
|
|
|
Interpreting the query:
|
|
|
|
| Column | Description |
|
|
| ------------------ | --------------------------------------------------- |
|
|
| `connection_id` | connection id |
|
|
| `ssl` | Indicates if SSL is in use |
|
|
| `database` | Name of the connected database (usually `postgres`) |
|
|
| `usename` | Role of the connected user |
|
|
| `application_name` | Name of the connecting application |
|
|
| `client_addr` | IP address of the connecting server |
|
|
| `query` | Last query executed by the connection |
|
|
| `query_start` | Time when the last query was executed |
|
|
| `state` | Querying state: active or idle |
|
|
| `backend_start` | Timestamp of the connection's establishment |
|
|
|
|
The username can be used to identify the source:
|
|
|
|
| Role | API/Tool |
|
|
| ---------------------------- | ------------------------------------------------------------------------- |
|
|
| `supabase_admin` | Used by Supabase for monitoring and by Realtime |
|
|
| `authenticator` | Data API (PostgREST) |
|
|
| `supabase_auth_admin` | Auth |
|
|
| `supabase_storage_admin` | Storage |
|
|
| `supabase_replication_admin` | Synchronizes Read Replicas |
|
|
| `postgres` | Supabase Dashboard and External Tools (e.g., Prisma, SQLAlchemy, PSQL...) |
|
|
| Custom roles defined by user | External Tools (e.g., Prisma, SQLAlchemy, PSQL...) |
|