Skip to content

Commit fb6f625

Browse files
chore: add docs for new db reports charts (supabase#36703)
* chore: add docs for new db reports charts * chore: fix linting issues * move db reports docs to telemetry section * add more info to reports docs * fix lint suggestions * update reports * update latest links and chart screenshots * advanced telemetry * update db section
1 parent a797ae2 commit fb6f625

16 files changed

+346
-2
lines changed

apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2357,6 +2357,10 @@ export const telemetry: NavMenuConstant = {
23572357
name: 'Log drains',
23582358
url: '/guides/telemetry/log-drains',
23592359
},
2360+
{
2361+
name: 'Reports',
2362+
url: '/guides/telemetry/reports',
2363+
},
23602364
{
23612365
name: 'Metrics',
23622366
url: '/guides/telemetry/metrics',

apps/docs/content/guides/database/connection-management.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,32 @@ These numbers are generalizations and depends on other Supabase products that yo
2323

2424
### Capturing historical usage
2525

26+
#### Dashboard monitoring charts
27+
28+
<Image
29+
alt="Database client connections chart"
30+
zoomable
31+
src={{
32+
dark: '/docs/img/database/reports/db-connections-chart-dark.png',
33+
light: '/docs/img/database/reports/db-connections-chart-light.png',
34+
}}
35+
/>
36+
37+
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:
38+
39+
- **Postgres**: Direct connections from your application
40+
- **PostgREST**: Connections from the PostgREST API layer
41+
- **Reserved**: Administrative connections for Supabase services
42+
- **Auth**: Connections from Supabase Auth service
43+
- **Storage**: Connections from Supabase Storage service
44+
- **Other roles**: Miscellaneous database connections
45+
46+
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.
47+
48+
For more details on using these monitoring charts, see the [Reports guide](/docs/guides/telemetry/reports#advanced-telemetry).
49+
50+
#### Grafana Dashboard
51+
2652
Supabase offers a Grafana Dashboard that records and visualizes over 200 project metrics, including connections. For setup instructions, check the [metrics docs](/docs/guides/platform/metrics).
2753

2854
Its "Client Connections" graph displays connections for both Supavisor and Postgres

apps/docs/content/guides/telemetry/reports.mdx

Lines changed: 309 additions & 0 deletions
Large diffs are not rendered by default.
26.7 KB
Loading
31 KB
Loading
24.7 KB
Loading
28.7 KB
Loading
21.4 KB
Loading
25 KB
Loading
24 KB
Loading

0 commit comments

Comments
 (0)