mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
Miranda Limonczenko
0d465e7b5f
Closes FE-3966 ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem - The admonition uses both 'tip' and 'note', but the visual distinction has long-ago collapsed. - 'Note' is used far more frequently than 'tip' - The two are very similar and it is confusing to know which one to use when they are visually identical ## Solution Collapse 'tip' and 'note' into one by removing all places where there is 'tip' and updating all references to 'tip' into 'note'. **Note:** This PR also resolves new broken links flagged by the E2E docs checker. It may move to another PR since E2Es keep erroring. ### Specific changes See below for an AI-generated list of changes: - **Type system** — removed `'tip'` from `AdmonitionType`, its `TYPE_TO_VARIANT`/`TYPE_LABEL` entries, and the test case in [`packages/ui-patterns/src/Admonition/](packages/ui-patterns/src/Admonition/) - **Remark plugin** — [remarkAdmonition.ts](apps/docs/lib/mdx/plugins/remarkAdmonition.ts) now maps mkdocs `tip` → `note` - **Lint allowlist** — `tip` dropped from `supa-mdx-lint.config.toml` - **Content migration** — all 109 files with `type="tip"` (across `apps/docs`, `apps/www`, `apps/studio`) converted to `type="note"`; zero remaining hits confirmed by repo-wide grep - **Style guide** — `CONTRIBUTING.md` and `contributing/content.mdx` updated to describe 4 admonition types instead of 5 ### Usage before implementation See the usage table that points toward 'note' as being dominant across all apps: Here's the usage table: | Location | `note` | `tip` | |---|---|---| | apps/docs | ~480 | ~143 | | apps/studio | 34 | 6 | | apps/www (blog) | 19 | 3 | | packages/ui-patterns (tests) | 3 | 1 (parametrized) | | design-system / ui-library / packages/ui / packages/common | 0–1 (test fixture only) | 0 | ## Preview links | App | Page | Search text (Ctrl+F) | Verify | |---|---|---|---| | docs | [/docs/guides/ai-tools/byo-mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/byo-mcp) | official MCP TypeScript SDK | callout's aria-label="Note" | | docs | [/docs/guides/ai-tools/mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/mcp) | MCP server is available at | callout's aria-label="Note" | | docs | [/docs/guides/ai/python-clients](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai/python-clients) | Click Connect at the top of any project page | callout's aria-label="Note" | | docs | [/docs/guides/auth/audit-logs](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/auth/audit-logs) | Disabling Postgres storage reduces your database storage costs | callout's aria-label="Note" | | docs | [/docs/guides/database/tables](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/database/tables) | access a custom schema through the Supabase Data API | callout's aria-label="Note" | | docs | [/docs/guides/troubleshooting/edge-function-404-error-response](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/troubleshooting/edge-function-404-error-response) | Always configure an appropriate time frame | callout's aria-label="Note" (was single-quoted type='tip') | | www | [blog: cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code) | Detecting config drift | callout's aria-label="Note" | | www | [blog: cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code) | Setting Edge Function secrets | callout's aria-label="Note" | | www | [blog: nosql-mongodb-compatibility-with-ferretdb-and-flydotio](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/nosql-mongodb-compatibility-with-ferretdb-and-flydotio) | If your network supports IPv6 connections | callout's aria-label="Note" | Note: the `www` rows use the `zone-www-dot-com` preview host, not the `docs` one you gave — since blog pages are served from the www app, not docs. ## Manual testing 1. Open preview links for affected pages. 2. Inspect. Open console. 3. Paste the following in and see there is no 'Tip' on the page: ``` document.querySelectorAll('[role="alert"]').forEach(el => console.log(el.getAttribute('aria-label'), el.textContent.slice(0,60))) ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized informational callouts across docs and tutorials from **“Tip”** to **“Note”**, updating multiple examples and guidance blocks. * Updated a few related doc references/links and conditional “Next steps” content. * **UI Updates** * Switched various in-app banners and notices to the **“Note”** style variant. * **Bug Fixes / Improvements** * Removed support for the retired **“Tip”** callout type and aligned docs linting, component behavior, and aria labeling to the remaining admonition types. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
67 lines
4.2 KiB
Plaintext
67 lines
4.2 KiB
Plaintext
---
|
|
id: 'limits'
|
|
title: 'Realtime Limits'
|
|
description: 'Understanding Realtime limits'
|
|
sidebar_label: 'Limits'
|
|
---
|
|
|
|
Our cluster supports millions of concurrent connections and message throughput for production workloads.
|
|
|
|
<Admonition type="note">
|
|
|
|
Upgrade your plan to increase your limits. Without a spend cap, or on an Enterprise plan, some limits are still in place to protect budgets. All limits are configurable per project. [Contact support](/dashboard/support/new) if you need your limits increased.
|
|
|
|
</Admonition>
|
|
|
|
## Limits by plan
|
|
|
|
| | Free | Pro | Pro (no spend cap) | Team | Enterprise |
|
|
| -------------------------------------------------------------------------------------------------- | -------- | -------- | ------------------ | -------- | ---------- |
|
|
| **Concurrent connections** | 200 | 500 | 10,000 | 10,000 | 10,000+ |
|
|
| **Messages per second** | 100 | 500 | 2,500 | 2,500 | 2,500+ |
|
|
| **Channel joins per second** | 100 | 500 | 2,500 | 2,500 | 2,500+ |
|
|
| **Channels per connection** | 100 | 100 | 100 | 100 | 100+ |
|
|
| **Presence keys per object** | 10 | 10 | 10 | 10 | 10+ |
|
|
| **Presence messages per second** | 20 | 50 | 1,000 | 1,000 | 1,000+ |
|
|
| **Presence calls per client, per 30 seconds** | 5 | 5 | 5 | 5 | 5 |
|
|
| **Broadcast payload size** | 256 KB | 3,000 KB | 3,000 KB | 3,000 KB | 3,000+ KB |
|
|
| **Postgres change payload size ([**read more**](#postgres-changes-payload-limit))** | 1,024 KB | 1,024 KB | 1,024 KB | 1,024 KB | 1,024+ KB |
|
|
| **Broadcast replay retention ([**read more**](/docs/guides/realtime/broadcast#broadcast-replay))** | 72 hours | 72 hours | 72 hours | 72 hours | 72 hours |
|
|
| **Broadcast replay messages per request** | 25 | 25 | 25 | 25 | 25 |
|
|
|
|
Beyond the Free and Pro Plan you can customize your limits by [contacting support](/dashboard/support/new).
|
|
|
|
## Limit errors
|
|
|
|
When you exceed a limit, errors will appear in the backend logs and client-side messages in the WebSocket connection.
|
|
|
|
- **Logs**: check the [Realtime logs](/dashboard/project/_/database/realtime-logs) inside your project Dashboard.
|
|
- **WebSocket errors**: Use your browser's developer tools to find the WebSocket initiation request and view individual messages.
|
|
|
|
<Admonition type="note" title="Realtime Inspector">
|
|
|
|
You can use the [Realtime Inspector](https://realtime.supabase.com/inspector/new) to reproduce an error and share those connection details with Supabase support.
|
|
|
|
</Admonition>
|
|
Some limits can cause a Channel join to be refused. Realtime will reply with one of the following WebSocket messages:
|
|
|
|
### `too_many_channels`
|
|
|
|
Too many channels currently joined for a single connection.
|
|
|
|
### `too_many_connections`
|
|
|
|
Too many total concurrent connections for a project.
|
|
|
|
### `too_many_joins`
|
|
|
|
Too many Channel joins per second.
|
|
|
|
### `tenant_events`
|
|
|
|
Connections will be disconnected if your project is generating too many messages per second. `supabase-js` will reconnect automatically when the message throughput decreases below your plan limit. An `event` is a WebSocket message delivered to, or sent from a client.
|
|
|
|
## Postgres changes payload limit
|
|
|
|
When this limit is reached, the `new` and `old` record payloads only include the fields with a value size of less than or equal to 64 bytes.
|