-
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
Open
dalextorres
wants to merge
9
commits into
master
Choose a base branch
from
alejandro.torres/add-supabase-link-dbm-postgres-setup
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
131e6e8
Add Supabase link to DBM Postgres setup page
dalextorres 21c79c6
Add Supabase Cloud DBM setup page and restructure Supabase docs
dalextorres 47a494c
Add dbm_postgres_supabase to left-nav level-4 allowlist
dalextorres 27245e4
Fix Supabase integration tile URL to supabase-cloud
dalextorres d84b566
Add first instance free callout and per-project config note
dalextorres 8af7bb0
Add Supabase Cloud integration tile and product screenshots
dalextorres 6a51296
Update Supabase Cloud integration tile screenshot
dalextorres afed047
Remove free instance language, keep per-project config note
dalextorres 1c6861c
Merge master: resolve left-nav allowlist conflict
dalextorres File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
content/en/database_monitoring/setup_postgres/supabase/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| 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 | ||
|
|
||
| {{< img src="database_monitoring/supabase_cloud_integration_tile.png" alt="Supabase Cloud integration tile configuration" style="width:80%;" >}} | ||
|
|
||
| 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. | ||
|
|
||
| <div class="alert alert-info">Each Supabase project must be configured separately. Adding new projects to a connected Supabase account does not automatically enable Database Monitoring.</div> | ||
|
|
||
| ## 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. | ||
|
|
||
| {{< img src="database_monitoring/supabase_cloud_product.png" alt="Database Monitoring overview for a Supabase Cloud instance" style="width:100%;" >}} | ||
|
|
||
| ## Further reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: https://app.datadoghq.com/integrations/supabase-cloud | ||
| [2]: https://app.datadoghq.com/databases |
4 changes: 2 additions & 2 deletions
4
...ase_monitoring/setup_postgres/supabase.md → ...nitoring/setup_postgres/supabase/agent.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 👍 / 👎.