-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add Supabase Cloud DBM setup page and link to Postgres setup #35276
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
131e6e8
21c79c6
47a494c
27245e4
d84b566
8af7bb0
6a51296
afed047
1c6861c
4636609
a380e48
bf2cbbd
a6bf3c7
b7b84da
c16a7e5
2c689d4
69b4fd6
0436be0
025ffec
27a85d4
96068b1
e67a648
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| title: Setting Up Database Monitoring for Supabase Cloud | ||
| description: Install and configure Database Monitoring for Supabase with the Supabase Cloud integration. | ||
| further_reading: | ||
| - link: '/integrations/postgres/' | ||
| tag: 'Documentation' | ||
| text: 'Basic Postgres Integration' | ||
| - link: '/database_monitoring/setup_postgres/supabase/agent' | ||
| tag: 'Documentation' | ||
| text: 'Supabase Self-Hosted Setup (Agent Installation)' | ||
| --- | ||
|
|
||
| Database Monitoring for Supabase Cloud provides visibility into your Supabase databases by exposing query performance metrics and query samples — without requiring a self-hosted Datadog Agent. | ||
|
|
||
| <div class="alert alert-info">For self-hosted Supabase deployments that require a Datadog Agent, see <a href="/database_monitoring/setup_postgres/supabase/agent">Supabase Self-Hosted Setup</a>.</div> | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Supabase project with a Postgres database. | ||
| - Your Supabase **Project ID** (found in your Supabase project settings). | ||
| - Your Supabase **API key** (found in your Supabase project settings under **API**). | ||
| - A Supabase **Personal Access Token** with access to the Management API. | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Navigate to the [Supabase integration tile][1] in Datadog. | ||
| 1. Click **Add Account**. | ||
| 1. Enter your Supabase **Project ID** and **API Key**. | ||
| 1. Select **Enable Database Monitoring for query performance optimizations**. | ||
| 1. Enter your **Personal Access Token**. | ||
| 1. Click **Save**. | ||
|
|
||
| Datadog connects to your Supabase project and begins collecting Database Monitoring telemetry. No Agent installation is required. | ||
|
|
||
| ## Data collected | ||
|
|
||
| After you enable Database Monitoring, Datadog collects the following telemetry from your Supabase Cloud database: | ||
|
|
||
| ### Query performance metrics | ||
| Sourced from `pg_stat_statements`, collected every 5 seconds: | ||
|
||
| - Call count and rows processed | ||
| - Total and average execution time | ||
| - Shared and local buffer hit/read/dirty/write statistics | ||
| - Block I/O read and write time | ||
| - Temporary buffer read and write counts | ||
|
|
||
| ### Query samples | ||
| Sourced from `pg_stat_activity`, collected every 5 seconds: | ||
| - Active and idle query snapshots | ||
| - Obfuscated query text and query signatures | ||
| - Wait event types and event names | ||
| - Session state and backend type | ||
| - Blocking PIDs | ||
| - Connection aggregates grouped by application, state, user, and database | ||
|
|
||
| ### Database instance metadata | ||
| Collected every 5 seconds: | ||
| - PostgreSQL version | ||
| - Instance identifier and hostname | ||
| - Connection mode (direct or pooler) | ||
|
|
||
| ## Validate | ||
|
|
||
| After setup, navigate to the [Database Monitoring][2] page in Datadog to see your Supabase database queries and performance metrics. | ||
|
|
||
| ## Further reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: https://app.datadoghq.com/integrations/supabase | ||
| [2]: https://app.datadoghq.com/databases | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: Setting Up Database Monitoring for Supabase | ||
| description: Install and configure Database Monitoring for Supabase. | ||
| title: Setting Up Database Monitoring for Supabase Self-Hosted | ||
| description: Install and configure Database Monitoring for Supabase with the Datadog Agent. | ||
|
Comment on lines
+2
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This rename makes the only Useful? React with 👍 / 👎. |
||
| further_reading: | ||
| - link: '/integrations/postgres/' | ||
| tag: 'Documentation' | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,6 +51,13 @@ | |
| </div> | ||
| </a> | ||
| </div> | ||
| <div class="col"> | ||
| <a class="card h-100" href="/database_monitoring/setup_postgres/supabase"> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This Postgres card partial is reused on Useful? React with 👍 / 👎. |
||
| <div class="card-body text-center py-2 px-1"> | ||
| {{ partial "img.html" (dict "root" . "src" "integrations_logos/supabase.png" "class" "img-fluid" "alt" "Supabase" "width" "175") }} | ||
| </div> | ||
| </a> | ||
| </div> | ||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These new entries are attached under
dbm_postgres_supabase, which creates a fourth navigation level, but the left-nav renderer hides level-4 submenus withd-noneunless the parent identifier is explicitly allowlisted (layouts/partials/nav/left-nav.html, around lines 69-72, currently only includesdbm_setup_postgres_rdsfor this DBM section). Becausedbm_postgres_supabaseis not in that allowlist, the new “Supabase Cloud”/“Supabase Self-Hosted” items will not appear in the sidebar even when Supabase is expanded, so users can’t discover them through primary docs navigation.Useful? React with 👍 / 👎.