Skip to content

Document unified concurrency limit (CUS-275) #436

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.

Sign up for GitHub

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

Draft
Jayko001 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −10
Draft

Document unified concurrency limit (CUS-275) #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions info/pricing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,18 @@ Auth sessions are fast (typically 5-30 seconds each). Kernel monitors session he

## Concurrency limits

Kernel enforces a single concurrency limit covering all browsers you run at once — whether created on demand with `browsers.create()` or reserved in a [browser pool](/browsers/pools/overview). Your full limit is available to either API in any mix.

| Feature | Developer (free + usage) | Hobbyist ($30 / mo + usage) | Start-Up ($200 / mo + usage) | Enterprise |
| --- | --- | --- | --- | --- |
| Reserved browsers ([browser pools](/browsers/pools/overview)) | 0 | 0 | 100 | Custom |
| On-demand browsers | 5 | 10 | 50 | Custom |
| Concurrent browsers | 5 | 10 | 150 | Custom |
| App invocations | 5 | 10 | 50 | Custom |
| App invocations (per-app) | 5 | 10 | 20 | Custom |
| Managed auth health check interval | N/A | 1 hour minimum | 20 minutes minimum | Custom |

> Note: Browsers in [Standby Mode](/browsers/standby) count against on-demand concurrency limits.
> Note: Reserved capacity in a [browser pool](/browsers/pools/overview) counts toward your concurrency limit whether or not the browsers are currently acquired — a pool sized to 40 browsers uses 40 of your limit. Browser pools are available on Start-Up and Enterprise plans.

> Note: Browsers in [Standby Mode](/browsers/standby) count against your concurrency limit.

> Note: Limits are org-wide by default unless stated otherwise. `Managed auth profiles` refer to profiles with active auth connections that Kernel maintains using your stored [Credentials](/auth/credentials) or [1Password connection](/integrations/1password). A single profile can have multiple auth connections (one per domain) — see [Profiles](/auth/profiles#multiple-auth-connections-per-profile) for details.

Expand Down
14 changes: 9 additions & 5 deletions info/projects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,9 +320,9 @@ if err := client.Projects.Delete(ctx, "proj_abc123"); err != nil {

## Concurrency Limits

Kernel caps how many browser sessions can run at once, at two levels:
Kernel caps how many browsers can run at once, at two levels. A single limit covers both on-demand browsers (`browsers.create()`) and [browser pools](/browsers/pools/overview) — standalone sessions and reserved pool capacity count against the same cap.

- **Organization limit** — the total concurrent sessions allowed across your whole organization, determined by your plan. Every session counts against it.
- **Organization limit** — the total concurrent browsers allowed across your whole organization, determined by your plan. Every browser session and every reserved pool slot counts against it.
- **Per-project limits** — optional caps on individual projects, so one team or environment can't consume the entire org limit.

Per-project caps come from two places:
Expand All @@ -336,18 +336,22 @@ A project's effective cap resolves in this order:
2. Otherwise, the organization's default project cap, if set.
3. Otherwise, no per-project cap — only the organization limit applies.

A per-project cap never lets a project exceed your organization's concurrent-session limit.
A per-project cap never lets a project exceed your organization's concurrency limit.

| Method | Path | Description |
| --- | --- | --- |
| `GET` | `/org/limits` | Get the org concurrent-session limit and the default per-project cap |
| `GET` | `/org/limits` | Get the org concurrency limit and the default per-project cap |
| `PATCH` | `/org/limits` | Set the default per-project cap (send `0` to clear it) |
| `GET` | `/org/projects/{id}/limits` | Get a single project's limit overrides |
| `PATCH` | `/org/projects/{id}/limits` | Set a single project's limit overrides (send `0` to clear a cap) |

<Info>
`max_pooled_sessions` is deprecated. Pooled browsers now count toward `max_concurrent_sessions`, and requests that set `max_pooled_sessions` return a `400`.
</Info>

### Set an org-wide default

Apply a default of 10 concurrent sessions to every project that doesn't have its own override:
Apply a default of 10 concurrent browsers to every project that doesn't have its own override:

<CodeGroup>
```bash cURL
Expand Down
4 changes: 2 additions & 2 deletions reference/cli/projects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ Update per-project limit overrides. Pass `0` to a limit to remove the cap for th

| Flag | Description |
|------|-------------|
| `--max-concurrent-sessions <n>` | Maximum concurrent browser sessions (0 to remove cap). |
| `--max-concurrent-sessions <n>` | Maximum concurrent browsers, covering both on-demand sessions and browser pool reservations (0 to remove cap). |
| `--max-concurrent-invocations <n>` | Maximum concurrent app invocations (0 to remove cap). |
| `--max-pooled-sessions <n>` | Maximum pooled sessions capacity (0 to remove cap). |
| `--max-pooled-sessions <n>` | Deprecated — pooled browsers now count toward `--max-concurrent-sessions`. |
| `--output json`, `-o json` | Output raw JSON object. |

```bash
Expand Down
Loading