Skip to content

tidb: global memory arbitrator mechanism#22882

Open
hfxsd wants to merge 5 commits into
pingcap:masterfrom
hfxsd:solotzg-patch-1-20955
Open

tidb: global memory arbitrator mechanism#22882
hfxsd wants to merge 5 commits into
pingcap:masterfrom
hfxsd:solotzg-patch-1-20955

Conversation

@hfxsd
Copy link
Copy Markdown
Collaborator

@hfxsd hfxsd commented May 13, 2026

This PR is translated from: pingcap/docs-cn#20955

First-time contributors' checklist

What is changed, added or deleted? (Required)

Add documentation for the TiDB global memory arbitrator mode, including:

  • Add a Memory arbitrator mode section to configure-memory-usage.md, describing the working principles, configuration methods, monitoring metrics, and best practices for the standard and priority modes.
  • Add descriptions for the following system variables to system-variables.md:
    • tidb_mem_arbitrator_mode: sets the global memory management mode for a TiDB instance.
    • tidb_mem_arbitrator_query_reserved: sets the amount of memory reserved in advance for a SQL statement before execution.
    • tidb_mem_arbitrator_soft_limit: sets the upper limit of memory allocation for a TiDB instance.
    • tidb_mem_arbitrator_wait_averse: controls the behavior of SQL statements when waiting for memory resources, including the meanings of the values 0 (default, disabled), 1, and nolimit.

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 (in Chinese).

  • 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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

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

@hfxsd hfxsd added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. labels May 13, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

@hfxsd hfxsd self-assigned this May 13, 2026
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 13, 2026
Synced from: pingcap/docs-cn#20955
Target PR: pingcap#22882
AI Provider: azure

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

Auto-sync completed successfully

Source PR: pingcap/docs-cn#20955
Target PR: #22882

English documentation has been updated based on Chinese documentation changes.

@ti-chi-bot ti-chi-bot Bot removed the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 13, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 13, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from hfxsd. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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 size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 13, 2026
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread configure-memory-usage.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Copy link
Copy Markdown
Contributor

@solotzg solotzg left a comment

Choose a reason for hiding this comment

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

lgtm

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 14, 2026

@solotzg: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Update documentation references to use the new "memory arbitrator" naming and corrected anchor targets. Changed cross-doc links in configure-memory-usage.md and system-variables.md (e.g. tidb_mem_arbitrator_mode anchor, memory-arbitrator-mode anchor, and the high-memory alarm anchor) so they point to the renamed headings introduced for v9.0.0 and ensure consistent phrasing across the docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants