Update check-before-deployment.md #21842
Conversation
add link for command reference
Summary of ChangesHello @yiduoyunQ, 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 enhances the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
ti-chi-bot
bot
added
the
missing-translation-status
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
size/XS
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds helpful cross-references to the OS tuning documentation. My review focuses on correcting the link anchors, which appear to be broken, and slightly improving the sentence structure for better readability. The suggested changes ensure the links are functional and the text is clear and concise.
| 1. Refer to [Memory—transparent huge page (THP)](/tune-operating-system/#Memory—transparent huge page (THP)) and disable THP (Transparent Huge Pages). The memory access pattern of databases tends to be sparse rather than consecutive. If the high-level memory fragmentation is serious, higher latency will occur when THP pages are allocated. | ||
| 2. Refer to [I/O scheduler](/tune-operating-system/#I/O scheduler) and set the I/O Scheduler of the storage media. | ||
|
|
||
| - For the high-speed SSD storage, the kernel's default I/O scheduling operations might cause performance loss. It is recommended to set the I/O Scheduler to first-in-first-out (FIFO), such as `noop` or `none`. This configuration allows the kernel to pass I/O requests directly to hardware without scheduling, thus improving performance. | ||
| - For NVMe storage, the default I/O Scheduler is `none`, so no adjustment is needed. | ||
| 3. Choose the `performance` mode for the cpufrequ module which controls the CPU frequency. The performance is maximized when the CPU frequency is fixed at its highest supported operating frequency without dynamic adjustment. | ||
| 3. Refer to [CPU—frequency scaling](/tune-operating-system/#CPU—frequency scaling) and choose the `performance` mode for the cpufrequ module which controls the CPU frequency. The performance is maximized when the CPU frequency is fixed at its highest supported operating frequency without dynamic adjustment. |
There was a problem hiding this comment.
Thanks for adding these helpful cross-references. The links seem to be broken due to spaces and special characters in the URL anchors. I've corrected them in the suggestion.
I also slightly rephrased the sentences for better readability, changing 'Refer to ... and ...' to 'Refer to ... to ...'.
| 1. Refer to [Memory—transparent huge page (THP)](/tune-operating-system/#Memory—transparent huge page (THP)) and disable THP (Transparent Huge Pages). The memory access pattern of databases tends to be sparse rather than consecutive. If the high-level memory fragmentation is serious, higher latency will occur when THP pages are allocated. | |
| 2. Refer to [I/O scheduler](/tune-operating-system/#I/O scheduler) and set the I/O Scheduler of the storage media. | |
| - For the high-speed SSD storage, the kernel's default I/O scheduling operations might cause performance loss. It is recommended to set the I/O Scheduler to first-in-first-out (FIFO), such as `noop` or `none`. This configuration allows the kernel to pass I/O requests directly to hardware without scheduling, thus improving performance. | |
| - For NVMe storage, the default I/O Scheduler is `none`, so no adjustment is needed. | |
| 3. Choose the `performance` mode for the cpufrequ module which controls the CPU frequency. The performance is maximized when the CPU frequency is fixed at its highest supported operating frequency without dynamic adjustment. | |
| 3. Refer to [CPU—frequency scaling](/tune-operating-system/#CPU—frequency scaling) and choose the `performance` mode for the cpufrequ module which controls the CPU frequency. The performance is maximized when the CPU frequency is fixed at its highest supported operating frequency without dynamic adjustment. | |
| 1. Refer to [Memory—transparent huge page (THP)](/tune-operating-system/#memorytransparent-huge-page-thp) to disable THP (Transparent Huge Pages). The memory access pattern of databases tends to be sparse rather than consecutive. If the high-level memory fragmentation is serious, higher latency will occur when THP pages are allocated. | |
| 2. Refer to [I/O scheduler](/tune-operating-system/#io-scheduler) to set the I/O Scheduler of the storage media. | |
| - For the high-speed SSD storage, the kernel's default I/O scheduling operations might cause performance loss. It is recommended to set the I/O Scheduler to first-in-first-out (FIFO), such as `noop` or `none`. This configuration allows the kernel to pass I/O requests directly to hardware without scheduling, thus improving performance. | |
| - For NVMe storage, the default I/O Scheduler is `none`, so no adjustment is needed. | |
| 3. Refer to [CPU—frequency scaling](/tune-operating-system/#cpufrequency-scaling) to choose the `performance` mode for the cpufrequ module which controls the CPU frequency. The performance is maximized when the CPU frequency is fixed at its highest supported operating frequency without dynamic adjustment. |
|
@hfxsd please take a look when you have time, thanks |
add link for command reference
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)?
Do your changes match any of the following descriptions?