Skip to content

docs: combined concurrency limits and queue gates - #4853

Open
matt-aitken wants to merge 9 commits into
feat/queue-concurrency-metricsfrom
docs/queue-concurrency-features
Open

docs: combined concurrency limits and queue gates#4853
matt-aitken wants to merge 9 commits into
feat/queue-concurrency-metricsfrom
docs/queue-concurrency-features

Conversation

@matt-aitken

Copy link
Copy Markdown
Member

Summary

Documents the queue concurrency features shipping in this stack: the combinedConcurrencyLimit queue option that caps a keyed queue across all of its concurrencyKey values, queue gates (array queue syntax for holding a slot in more than one queue), and the combined override/reset SDK methods and endpoints.

The concurrency guide gains sections on combined limits and gates with self-hosting notes for the server flags, the OpenAPI spec gains the two combined endpoints and the concurrency.combined response field, and the management reference gains pages for both new endpoints.

Stacked on #4830.

@changeset-bot

changeset-bot Bot commented Aug 31, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: bf2e961

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Team

Run ID: 524dbd1f-5cfa-4c64-8de1-a26e10cfb732

📥 Commits

Reviewing files that changed from the base of the PR and between eb33462 and e07558e.

📒 Files selected for processing (1)
  • docs/queue-concurrency.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/queue-concurrency.mdx

Included review availability: Your plan provides up to 10 included reviews per hour; 3 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (3)
  • GitHub Check: code-quality / code-quality
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Build and publish previews

Walkthrough

The OpenAPI specification adds combined concurrency override and reset endpoints. It documents combined concurrency state on QueueObject and requires a request body for the existing reset endpoint. The queue concurrency guide adds combined-limit patterns, gate queue examples, tenant and shared-resource limits, and SDK override and reset methods. Documentation navigation adds separate pages for the new endpoints.

Merge Risk: ⚪ Minimal · up to bf2e9

This change documents combined queue concurrency APIs, configuration, and usage patterns. No current merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description accurately summarizes the documentation changes, but it does not follow the repository template. It omits the required checklist, testing details, changelog, screenshots section, and i… Add the required template sections. Include the relevant issue reference, complete the checklist, describe testing performed, add a short changelog entry, and include the screenshots section or state that screenshots are not applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main documentation changes for combined concurrency limits and queue gates. It is concise and specific.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description accurately summarizes the documentation changes, but it does not follow the repository template. It omits the required checklist, testing details, changelog, screenshots section, and issue-closing line.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/queue-concurrency-features

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

devin-ai-integration[bot]

This comment was marked as resolved.

@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch 2 times, most recently from 05bef1a to 7998d68 Compare August 31, 2026 17:34
devin-ai-integration[bot]

This comment was marked as resolved.

@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch 5 times, most recently from af1ed4f to ab4c607 Compare August 31, 2026 18:13
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from e73840d to 34b2cfb Compare September 6, 2026 12:20
@pkg-pr-new

pkg-pr-new Bot commented Sep 6, 2026

Copy link
Copy Markdown

Open in StackBlitz

@trigger.dev/build

npm i https://pkg.pr.new/@trigger.dev/build@bf2e961

trigger.dev

npm i https://pkg.pr.new/trigger.dev@bf2e961

@trigger.dev/core

npm i https://pkg.pr.new/@trigger.dev/core@bf2e961

@trigger.dev/python

npm i https://pkg.pr.new/@trigger.dev/python@bf2e961

@trigger.dev/react-hooks

npm i https://pkg.pr.new/@trigger.dev/react-hooks@bf2e961

@trigger.dev/redis-worker

npm i https://pkg.pr.new/@trigger.dev/redis-worker@bf2e961

@trigger.dev/rsc

npm i https://pkg.pr.new/@trigger.dev/rsc@bf2e961

@trigger.dev/schema-to-json

npm i https://pkg.pr.new/@trigger.dev/schema-to-json@bf2e961

@trigger.dev/sdk

npm i https://pkg.pr.new/@trigger.dev/sdk@bf2e961

commit: bf2e961

coderabbitai[bot]

This comment was marked as resolved.

@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 34b2cfb to 947879a Compare September 6, 2026 12:33
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 947879a to 2e0ae55 Compare September 6, 2026 12:37
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 2e0ae55 to 1772166 Compare September 6, 2026 12:45
coderabbitai[bot]

This comment was marked as resolved.

@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch 2 times, most recently from 99fc054 to 7cd93f1 Compare September 6, 2026 13:00
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 7cd93f1 to 2250f8e Compare September 6, 2026 13:14
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 2250f8e to b70f42a Compare September 6, 2026 13:20
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from b70f42a to b4d89eb Compare September 6, 2026 13:21
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 7038e96 to 1d2ac16 Compare September 6, 2026 15:12
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 1d2ac16 to f9f6ea8 Compare September 6, 2026 15:17
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from f9f6ea8 to 7d3d148 Compare September 6, 2026 15:21
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 7d3d148 to d8b396d Compare September 6, 2026 15:43
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from d8b396d to 7d38a93 Compare September 6, 2026 15:47
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 7d38a93 to 98b74d9 Compare September 6, 2026 15:59
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 98b74d9 to a615cbb Compare September 6, 2026 16:04
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from a615cbb to 40f9d4f Compare September 6, 2026 16:08
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from 40f9d4f to b5f2d4f Compare September 6, 2026 17:02
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from b5f2d4f to b59bdb0 Compare September 6, 2026 17:23
…body required

The gates intro promised a task-wide cap the keyed example does not
deliver (a concurrencyKey splits the home queue per key); the combined
object is emitted on every queue with null fields rather than omitted;
and both reset endpoints reject a zero-length body, so the body is
required. Also restores the example that drifted off overriddenAt.
A Use cases index links each goal to its section, the multi-queue
section names the home queue and gate concepts once and gives each
pattern its own worked example (per-tenant cap across tasks, global cap
for a shared resource via a combined-only queue, pinned-key shared
pool), and the per-key-except-combined rule gets a warning callout.
Folds in the simplified wording and removes self-hosting notes.
The combined limit only counts keyed runs, so the shared-resource
example now shows the keyed trigger and warns that keyless runs bypass
the cap, pointing those cases at the pinned-key pool.
@matt-aitken
matt-aitken force-pushed the docs/queue-concurrency-features branch from b59bdb0 to bf2e961 Compare September 6, 2026 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant