tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704) #20725
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
do-not-merge/hold
|
@Rustin170506 This PR has conflicts, I have hold it. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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!
Summary of Changes
This pull request focuses on enhancing the clarity and ensuring consistency in the documentation for the tidb_auto_analyze_concurrency system variable. The primary change involves updating descriptions in the releases/release-8.4.0.md and system-variables.md files to accurately reflect the variable's function, which is to control the number of concurrent auto-analyze operations within a TiDB cluster, rather than setting concurrency within a single task. This change aims to prevent misinterpretations and provide a more precise understanding of the variable's role.
Highlights
- Documentation Update: The descriptions of the
tidb_auto_analyze_concurrencysystem variable have been updated inreleases/release-8.4.0.mdandsystem-variables.mdto clarify its purpose. - Consistency: Ensuring that the documentation consistently describes the
tidb_auto_analyze_concurrencyvariable as controlling the number of concurrent auto-analyze operations cluster-wide. - Clarity: Improving the clarity of the documentation to avoid misinterpretations regarding the function of the
tidb_auto_analyze_concurrencysystem variable.
Changelog
- releases/release-8.4.0.md
- Updated the description of
tidb_auto_analyze_concurrencyto specify that it controls the number of concurrent auto-analyze operations within a TiDB cluster. - Modified the description in the feature list to accurately reflect the function of the
tidb_auto_analyze_concurrencyvariable.
- Updated the description of
- system-variables.md
- Revised the description of
tidb_auto_analyze_concurrencyto clarify that it controls the number of concurrent auto-analyze operations that can run in a TiDB cluster.
- Revised the description of
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.
A variable's intent,
Must be clear, well-defined, sent.
No room for doubt,
Let clarity sprout,
In code and docs, heaven-lent.
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. ↩
ti-chi-bot
bot
added
size/M
There was a problem hiding this comment.
Code Review
The pull request aims to enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency. The changes involve modifications to documentation files to accurately reflect the variable's function and scope. Overall, the changes seem reasonable and contribute to better understanding of the system variable.
Merge Readiness
The pull request appears to be in good shape for merging. The changes are well-scoped and address a specific issue related to documentation clarity and consistency. There are no immediate concerns that would prevent merging, but the author should address the review comments to further improve the quality of the changes.
system-variables.md
Outdated
| <<<<<<< HEAD | ||
| ======= | ||
| ### tidb_ddl_reorg_max_write_speed <span class="version-mark">New in v6.5.12, v7.5.5, and v8.5.0</span> | ||
|
|
||
| - Scope: GLOBAL | ||
| - Persists to cluster: Yes | ||
| - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No | ||
| - Type: String | ||
| - Default value: `0` | ||
| - Range: `[0, 1PiB]` | ||
| - This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in your cluster is quite large (such as billions of rows), limiting the write bandwidth for index creation can effectively reduce the impact on application workloads. | ||
| - The default value `0` means no write bandwidth limit. | ||
| - You can specify the value of this variable either with a unit or without a unit. | ||
| - When you specify the value without a unit, the default unit is bytes per second. For example, `67108864` represents `64MiB` per second. | ||
| - When you specify the value with a unit, supported units include KiB, MiB, GiB, and TiB. For example, `'1GiB`' represents 1 GiB per second, and `'256MiB'` represents 256 MiB per second. | ||
|
|
||
| >>>>>>> 1b43ba1548 (tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704)) |
There was a problem hiding this comment.
This section seems to be adding a new system variable tidb_ddl_reorg_max_write_speed. However, the diff includes <<<<<<< HEAD, =======, and >>>>>>> 1b43ba1548 (tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704)), which indicates a merge conflict. Please resolve this conflict to ensure the correctness of the file.
| <<<<<<< HEAD | |
| ======= | |
| ### tidb_ddl_reorg_max_write_speed <span class="version-mark">New in v6.5.12, v7.5.5, and v8.5.0</span> | |
| - Scope: GLOBAL | |
| - Persists to cluster: Yes | |
| - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No | |
| - Type: String | |
| - Default value: `0` | |
| - Range: `[0, 1PiB]` | |
| - This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in your cluster is quite large (such as billions of rows), limiting the write bandwidth for index creation can effectively reduce the impact on application workloads. | |
| - The default value `0` means no write bandwidth limit. | |
| - You can specify the value of this variable either with a unit or without a unit. | |
| - When you specify the value without a unit, the default unit is bytes per second. For example, `67108864` represents `64MiB` per second. | |
| - When you specify the value with a unit, supported units include KiB, MiB, GiB, and TiB. For example, `'1GiB`' represents 1 GiB per second, and `'256MiB'` represents 256 MiB per second. | |
| >>>>>>> 1b43ba1548 (tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704)) | |
| ### tidb_ddl_reorg_max_write_speed <span class="version-mark">New in v6.5.12, v7.5.5, and v8.5.0</span> | |
| - Scope: GLOBAL | |
| - Persists to cluster: Yes | |
| - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No | |
| - Type: String | |
| - Default value: `0` | |
| - Range: `[0, 1PiB]` | |
| - This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in your cluster is quite large (such as billions of rows), limiting the write bandwidth for index creation can effectively reduce the impact on application workloads. | |
| - The default value `0` means no write bandwidth limit. | |
| - You can specify the value of this variable either with a unit or without a unit. | |
| - When you specify the value without a unit, the default unit is bytes per second. For example, `67108864` represents `64MiB` per second. | |
| - When you specify the value with a unit, supported units include KiB, MiB, GiB, and TiB. For example, `'1GiB`' represents 1 GiB per second, and `'256MiB'` represents 256 MiB per second. | |
system-variables.md
Outdated
| <<<<<<< HEAD | ||
| ======= | ||
| - If the [`log.general-log-file`](/tidb-configuration-file.md#general-log-file-new-in-v800) configuration item is specified, the general log is written to the specified file separately. | ||
|
|
||
| - The [`log.format`](/tidb-configuration-file.md#format) configuration item enables you to configure the log message format, whether the general log is in a separate file or combined with other logs. | ||
|
|
||
| - The [`tidb_redact_log`](#tidb_redact_log) variable enables you to redact SQL statements recorded in the general log. | ||
|
|
||
| - Only successfully executed statements are logged in the general log. Failed statements are not recorded in the general log but are instead logged in the TiDB log with a `command dispatched failed` message. | ||
|
|
||
| >>>>>>> 1b43ba1548 (tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704)) |
There was a problem hiding this comment.
This section seems to be adding more information about the log.general-log-file configuration item. However, the diff includes <<<<<<< HEAD, =======, and >>>>>>> 1b43ba1548 (tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704)), which indicates a merge conflict. Please resolve this conflict to ensure the correctness of the file.
| <<<<<<< HEAD | |
| ======= | |
| - If the [`log.general-log-file`](/tidb-configuration-file.md#general-log-file-new-in-v800) configuration item is specified, the general log is written to the specified file separately. | |
| - The [`log.format`](/tidb-configuration-file.md#format) configuration item enables you to configure the log message format, whether the general log is in a separate file or combined with other logs. | |
| - The [`tidb_redact_log`](#tidb_redact_log) variable enables you to redact SQL statements recorded in the general log. | |
| - Only successfully executed statements are logged in the general log. Failed statements are not recorded in the general log but are instead logged in the TiDB log with a `command dispatched failed` message. | |
| >>>>>>> 1b43ba1548 (tidb: enhance clarity and ensure consistency for the system variable tidb_auto_analyze_concurrency (#20704)) | |
| - If the [`log.general-log-file`](/tidb-configuration-file.md#general-log-file-new-in-v800) configuration item is specified, the general log is written to the specified file separately. | |
| - The [`log.format`](/tidb-configuration-file.md#format) configuration item enables you to configure the log message format, whether the general log is in a separate file or combined with other logs. | |
| - The [`tidb_redact_log`](#tidb_redact_log) variable enables you to redact SQL statements recorded in the general log. | |
| - Only successfully executed statements are logged in the general log. Failed statements are not recorded in the general log but are instead logged in the TiDB log with a `command dispatched failed` message. |
|
@gemini-code-assist[bot]: 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. |
Oreoxmt
force-pushed
the
cherry-pick-20704-to-release-8.4
branch
from
e2a5147 to
8e20d74
Compare
ti-chi-bot
bot
added
size/XS
|
/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 |
|
/retest |
|
/unhold |
ti-chi-bot
bot
removed
the
do-not-merge/hold
Oreoxmt
force-pushed
the
cherry-pick-20704-to-release-8.4
branch
from
4ef6347 to
e2a5147
Compare
ti-chi-bot
bot
added
size/M
ti-chi-bot
bot
added
size/XS
|
/retest |
This is an automated cherry-pick of #20704
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.
What is the related PR or file link(s)?
The statement was wrong. It is used to set the concurrency for auto-analyzing operations within a TiDB cluster.
Do your changes match any of the following descriptions?