tikv: update auto compaction config (#21656) #21726
Conversation
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, I'm Gemini Code Assist1! 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!
This pull request updates the TiKV documentation to align with recent changes in how automatic RocksDB compaction is configured. It formalizes the deprecation of previous compaction-related parameters and introduces a new, more comprehensive set of configuration options under gc.auto-compaction. The aim is to provide users with up-to-date and accurate information for optimizing TiKV's storage performance through compaction management.
Highlights
- Configuration Parameter Deprecation: Several older TiKV compaction configuration parameters under
raftstorehave been deprecated, includingregion-compact-check-interval,region-compact-check-step,region-compact-min-tombstones, andregion-compact-tombstones-percent. - New Auto Compaction Parameters: A new set of
gc.auto-compactionparameters has been introduced, providing more granular control over automatic RocksDB compaction. These includecheck-interval,tombstone-num-threshold,tombstone-percent-threshold,redundant-rows-threshold,redundant-rows-percent-threshold, andbottommost-level-force. - Documentation Updates: The documentation has been updated across multiple files to reflect these changes, providing clear guidance on the new parameters, their usage, and the deprecation of older settings, along with version-specific advice for managing compaction filters.
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for TiKV's auto compaction configuration. It correctly removes deprecated raftstore.region-compact-* parameters and adds the new gc.auto-compaction.* parameters across several documentation files. My review focuses on improving clarity and ensuring adherence to the documentation style guide. I've suggested minor rephrasing for better readability, and corrected several formatting issues, including missing backticks around configuration parameters in links and a missing hyperlink for consistency.
tikv-configuration-file.md
Outdated
|
|
||
| ### `redundant-rows-percent-threshold` <span class="version-mark">New in v7.5.7 and v9.0.0</span> | ||
|
|
||
| + The percentage of redundant MVCC rows required to trigger TiKV automatic compaction. Redundant rows include RocksDB tombstones, TiKV stale versions, and TiKV deletion tombstones. When the number of redundant MVCC rows reaches [`redundant-rows-threshold`](#redundant-rows-threshold-new-in-v757-and-v900), or when the percentage of these rows reaches `redundant-rows-percent-threshold`, TiKV triggers automatic compaction. |
There was a problem hiding this comment.
For consistency and better navigation, redundant-rows-percent-threshold should also be a link, similar to the other parameter references in this section.
| + The percentage of redundant MVCC rows required to trigger TiKV automatic compaction. Redundant rows include RocksDB tombstones, TiKV stale versions, and TiKV deletion tombstones. When the number of redundant MVCC rows reaches [`redundant-rows-threshold`](#redundant-rows-threshold-new-in-v757-and-v900), or when the percentage of these rows reaches `redundant-rows-percent-threshold`, TiKV triggers automatic compaction. | |
| + The percentage of redundant MVCC rows required to trigger TiKV automatic compaction. Redundant rows include RocksDB tombstones, TiKV stale versions, and TiKV deletion tombstones. When the number of redundant MVCC rows reaches [`redundant-rows-threshold`](#redundant-rows-threshold-new-in-v757-and-v900), or when the percentage of these rows reaches [`redundant-rows-percent-threshold`](#redundant-rows-percent-threshold-new-in-v757-and-v900), TiKV triggers automatic compaction. |
| > **Note:** | ||
| > | ||
| > When using the Compaction Filter mechanism, GC progress might be delayed, which can affect TiKV scan performance. If your workload contains a large number of coprocessor requests and you observe in the [**TiKV-Details > Coprocessor Detail**](/grafana-tikv-dashboard.md#coprocessor-detail) panel that the `next()` or `prev()` call count in **Total Ops Details** significantly exceeds three times the `processed_keys` calls, you can take the following actions: |
There was a problem hiding this comment.
This sentence is a bit long and could be more direct. Consider rephrasing for better readability.1
| > When using the Compaction Filter mechanism, GC progress might be delayed, which can affect TiKV scan performance. If your workload contains a large number of coprocessor requests and you observe in the [**TiKV-Details > Coprocessor Detail**](/grafana-tikv-dashboard.md#coprocessor-detail) panel that the `next()` or `prev()` call count in **Total Ops Details** significantly exceeds three times the `processed_keys` calls, you can take the following actions: | |
| > When you use the Compaction Filter mechanism, GC progress might be delayed, which can affect TiKV scan performance. If your workload contains many coprocessor requests, check the **TiKV-Details > Coprocessor Detail** panel in Grafana. If the `next()` or `prev()` call count in **Total Ops Details** significantly exceeds three times the `processed_keys` calls, you can take the following actions: |
Style Guide References
Footnotes
-
The style guide recommends clarity, simplicity, and writing in the second person ('you'). Shorter, more direct sentences are easier to understand. ↩
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Oreoxmt
added
the
needs-cherry-pick-release-7.1
|
In response to a cherrypick label: new pull request created to branch |
Signed-off-by: ti-chi-bot <[email protected]>
This is an automated cherry-pick of #21656
First-time contributors' checklist
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 (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?