Skip to content

docs: clarify configurable concurrency in overview - #24207

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-overview-token-limit
Oct 20, 2026
Merged

ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-overview-token-limit

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

What is changed, added, or deleted? (Required)

Clarify the concurrency wording in overview.md.

The overview previously said that each TiDB node supports a maximum of 1,000 concurrencies. However, 1,000 is the default value of token-limit, not the maximum. This PR updates the overview to say that each TiDB node supports 1,000 concurrent sessions by default and that you can configure this limit up to 1,048,576.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Clarified that each TiDB node allows up to 1,000 sessions concurrently executing requests by default, configurable up to 1,048,576 with token-limit. The 512-node computing-layer maximum and PB-level cluster-capacity statement remain unchanged.
    • Updated the get token description to specify that token limiting applies when sessions concurrently executing requests on a TiDB instance reach token-limit, and linked to the relevant configuration details.

@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. area/general Relates to TiDB overview, architecture, and other general descriptions. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Oct 8, 2026
@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 8, 2026
@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 6c01c6bb-377d-4bdb-a52b-5500bd359724
📥 Commits

Reviewing files that changed from the base of the PR and between 28a6810 and adb7ebe.

📒 Files selected for processing (1)
  • overview.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

The documentation now describes per-node concurrent session capacity and clarifies when token limiting applies on a TiDB instance.

Changes: TiDB concurrency capacity

Layer / File(s) Summary
Session limits and token limiting
overview.md, performance-tuning-methods.md
The use-case description states a default of 1,000 concurrent sessions per TiDB node, adjustable up to 1,048,576 through token-limit. The get token description applies token limiting when sessions concurrently executing requests reach token-limit and links to its configuration section.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to adb7e

The overview and performance guidance consistently describe concurrent request-executing sessions, with the stated default and maximum matching the configuration reference. No merge-blocking issue is identified.

### Architecture Summary

Architecture risk: 🔵 Low · up to adb7e

The change affects 2 systems.

Changed systems: overview.md, performance-tuning-methods.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — overview.md (service) was modified; 1 changed file maps to changed impact.
  • observed — performance-tuning-methods.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in performance-tuning-methods.md: The get token limit condition changes from reaching the connection count on a TiDB instance to reaching the number of sessions concurrently executing requests there; the link now targets the token-limit configuration section.
  • observed — Modified behavior in overview.md: The use-case description replaces the per-node maximum of 1,000 concurrencies with a default limit of 1,000 sessions executing requests concurrently, adjustable up to 1,048,576 using token-limit; the 512-node computing-layer maximum and PB-level cluster-capacity statement remain.
Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Description check Passed The description explains the documentation change, its rationale, affected versions, reference links, and AI involvement. Required sections are present and sufficiently complete.
Title check Passed The title clearly and concisely describes the main change: clarifying configurable concurrency in the overview documentation.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@doc-claw-bot doc-claw-bot added translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. and removed missing-translation-status This PR does not have translation status info. labels Oct 8, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 246700a8-6cab-478d-ad3f-2485dfbcf594
📥 Commits

Reviewing files that changed from the base of the PR and between 6ba8576 and 05f47ed.

📒 Files selected for processing (1)
  • overview.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread overview.md Outdated
@lilin90 lilin90 added the ONCALL Relates to documentation oncall. label Oct 8, 2026
@lilin90 lilin90 self-assigned this Oct 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The wording still risks presenting token-limit as a session cap rather than a concurrent request-execution limit.

2 open findings
What changed in this PR

Clarifies how TiDB’s token-limit controls concurrent request execution.

Changes:

  • Documents the default and maximum token limits.
  • Clarifies token acquisition during SQL processing.
File Description
overview.md Updates concurrency limits in the overview.
performance-tuning-methods.md Clarifies when requests wait for tokens.

🧠 Review effort: Balanced


💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread overview.md Outdated
Comment thread performance-tuning-methods.md Outdated
Updated wording for clarity on session limits in TiDB.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread performance-tuning-methods.md Outdated
@lilin90 lilin90 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. labels Oct 13, 2026
github-actions Bot added a commit to lilin90/docs-cn that referenced this pull request Oct 13, 2026
Synced from: pingcap/docs#24207
Target PR: pingcap#21977

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@lilin90
lilin90 requested a review from GMHDBJD October 14, 2026 02:10
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-20 09:03:41.963210902 +0000 UTC m=+94634.223297819: ☑️ agreed by GMHDBJD.

@lilin90 lilin90 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@ti-chi-bot

ti-chi-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Oct 20, 2026
@lilin90 lilin90 added the lgtm label Oct 20, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 4c57396 into pingcap:master Oct 20, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #24510.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/general Relates to TiDB overview, architecture, and other general descriptions. contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants