add tikv compaction and flow control setting

[dbsid]

First-time contributors' checklist

• I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

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.4 (TiDB 8.4 versions)
• v8.3 (TiDB 8.3 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)?

• This PR is translated from:
• Other reference 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

[ti-chi-bot]

Hi @dbsid. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[gemini-code-assist]

Hello @dbsid, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello team, gemini-code-assist here to provide a summary of this pull request. This PR, authored by @dbsid, aims to enhance the documentation for TiDB performance tuning by adding specific guidance on configuring TiKV's compaction and flow control settings. The changes introduce new sections and table entries in the tidb-performance-tuning-config.md file, detailing several key RocksDB and storage parameters crucial for optimizing performance under write-intensive workloads and preventing write stalls.

Highlights

• Documentation Update: Adds a new section to the tidb-performance-tuning-config.md document specifically covering TiKV compaction and flow control settings for performance tuning.
• New Configuration Parameters: Documents several important TiKV configuration parameters related to RocksDB background I/O rate (rocksdb.rate-bytes-per-sec), MANIFEST file size (rocksdb.max-manifest-file-size), scheduler write queue threshold (storage.scheduler-pending-write-threshold), and flow control limits based on pending compaction bytes (storage.flow-control.soft-pending-compaction-bytes-limit, storage.flow-control.hard-pending-compaction-bytes-limit).
• Recommended Settings: Provides recommended adjustments for these new parameters tailored for write-intensive workloads on a specific instance hardware profile (32 cores, 128 GiB Mem, 5 TiB EBS, 1 GiB/s Disk).
• Flow Control Explanation: Includes a note explaining TiKV's scheduler-layer flow control mechanism and the implications of exceeding thresholds, such as receiving ServerIsBusy errors.

Changelog

• tidb-performance-tuning-config.md
  • Added a bullet point mentioning fine-tuning TiKV compaction and flow control as a common performance optimization setting.
  • Added [rocksdb] section with rate-bytes-per-sec and max-manifest-file-size to the example configuration.
  • Added [storage] section with scheduler-pending-write-threshold to the example configuration.
  • Added storage.flow-control section with soft-pending-compaction-bytes-limit and hard-pending-compaction-bytes-limit to the example configuration.
  • Added new rows to the configuration table explaining rocksdb.rate-bytes-per-sec, rocksdb.max-manifest-file-size, storage.scheduler-pending-write-threshold, storage.flow-control.soft-pending-compaction-bytes-limit, and storage.flow-control.hard-pending-compaction-bytes-limit.
  • Added a section detailing recommended configuration adjustments for write-intensive workloads based on specific hardware.
  • Added a note explaining TiKV's flow control mechanism and ServerIsBusy errors.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds valuable information about tuning TiKV's compaction and flow control settings for write-intensive workloads. The added configuration examples and explanations are clear and directly applicable. I've identified a few minor areas for improvement related to documentation style and a typo.

Summary of Findings

• Documentation Style: The heading 'Recommended Configuration Adjustments for Write-Intensive Workloads' does not follow the recommended sentence case convention for headings[^1].
• Typo: There is a typo ('flow controlss') in the final note block[^2].

Merge Readiness

The changes provide valuable information and are generally well-written. The identified issues are minor documentation style points and a typo. I recommend addressing these low-severity issues before merging to maintain documentation quality. I am unable to approve this pull request; please have other reviewers approve it before merging.

[ti-chi-bot]

@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Code Review

This pull request adds valuable information about tuning TiKV's compaction and flow control settings for write-intensive workloads. The added configuration examples and explanations are clear and directly applicable. I've identified a few minor areas for improvement related to documentation style and a typo.

Summary of Findings

• Documentation Style: The heading 'Recommended Configuration Adjustments for Write-Intensive Workloads' does not follow the recommended sentence case convention for headings[^1].
• Typo: There is a typo ('flow controlss') in the final note block[^2].

Merge Readiness

The changes provide valuable information and are generally well-written. The identified issues are minor documentation style points and a typo. I recommend addressing these low-severity issues before merging to maintain documentation quality. I am unable to approve this pull request; please have other reviewers approve it before merging.

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.

[ti-chi-bot]

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

In response to this:

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.

[shaoxiqian]

/lgtm

[ti-chi-bot]

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

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.

[hfxsd]

/bot-review

[github-actions]

✅ AI review completed, 4 comments generated.

[ti-chi-bot]

[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.

Needs approval from an approver in each of these files:

• OWNERS

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