premium: add tuning performance #22127
Conversation
ti-chi-bot
bot
added
contribution
|
Hi @huoyao1125. 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 Once the patch is verified, the new status will be reflected by the 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. |
ti-chi-bot
bot
added
the
needs-ok-to-test
Summary of ChangesHello @huoyao1125, 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 adds a new documentation page, "tune-performance-premium.md", which serves as a comprehensive guide for users of TiDB Cloud Premium instances. The document outlines how to effectively analyze and tune database performance by leveraging the platform's built-in Slow Query and SQL Statement features, providing clear steps for navigation and usage of these diagnostic tools. 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
missing-translation-status
![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 a new documentation page for analyzing and tuning performance on TiDB Cloud Premium Instances. The document is well-structured, but I have a few suggestions to improve clarity, consistency, and fix a broken link. My feedback focuses on standardizing terminology, correcting navigation steps to make them easier to follow, and rephrasing some sentences for better readability, in accordance with the repository's style guide.
|
|
||
| # Analyze and Tune Performance for Premium instances | ||
|
|
||
| TiDB Cloud provides [Slow Query](#slow-query), [SQL Statement](#statement-analysis) to analyze performance. |
There was a problem hiding this comment.
The link anchor for 'SQL Statement' is incorrect. The heading ## SQL Statement generates an anchor #sql-statement, not #statement-analysis, which results in a broken link. I've corrected the link and also made the feature names bold for emphasis, which is consistent with other documentation pages.
| TiDB Cloud provides [Slow Query](#slow-query), [SQL Statement](#statement-analysis) to analyze performance. | |
| TiDB Cloud provides [**Slow Query**](#slow-query) and [**SQL Statement**](#sql-statement) to help you analyze performance. |
| > | ||
| > You can use the combo box in the upper-left corner to switch between organizations and Premium instances. | ||
| 2. In the left navigation pane, click **Monitoring**. |
There was a problem hiding this comment.
This step is a bit confusing. The section heading is 'View the Diagnosis page', but this step instructs the user to click 'Monitoring' and stops there. To avoid confusion and guide the user correctly, it would be clearer to direct them to the 'Diagnosis' page itself.
| 2. In the left navigation pane, click **Monitoring**. | |
| 2. In the left navigation pane, click **Diagnosis**. |
|
|
||
| To view slow queries in a TiDB Instance, perform the following steps: | ||
|
|
||
| 1. Navigate and click the **Slow Query** page of a TiDB instance. |
There was a problem hiding this comment.
The instruction 'Navigate and click' is vague. To create a clearer, step-by-step flow from the previous section, it's better to specify that the user should now be on the 'Diagnosis' page and should select the 'Slow Query' tab.
| 1. Navigate and click the **Slow Query** page of a TiDB instance. | |
| 1. On the **Diagnosis** page, select the **Slow Query** tab. |
|
|
||
| To use the SQL Statement, perform the following steps: | ||
|
|
||
| 1. Navigate and click the **SQL Statement** page of a TiDB instance. |
There was a problem hiding this comment.
Similar to the 'Slow Query' section, this instruction is vague. It would be clearer to guide the user from the 'Diagnosis' page to create a more logical flow.
| 1. Navigate and click the **SQL Statement** page of a TiDB instance. | |
| 1. On the **Diagnosis** page, select the **SQL Statement** tab. |
| @@ -0,0 +1,52 @@ | |||
| --- | |||
| title: Analyze and Tune Performance for Premium instances | |||
There was a problem hiding this comment.
For consistency with the summary and to better reflect that this guide describes steps for a single instance, I suggest using the singular form 'Instance'.
| title: Analyze and Tune Performance for Premium instances | |
| title: Analyze and Tune Performance for a Premium Instance |
| aliases: ['/tidbcloud/index-insight'] | ||
| --- | ||
|
|
||
| # Analyze and Tune Performance for Premium instances |
There was a problem hiding this comment.
For consistency with the updated title, let's also use the singular form in the main heading.
| # Analyze and Tune Performance for Premium instances | |
| # Analyze and Tune Performance for a Premium Instance |
|
|
||
| ## View the Diagnosis page | ||
|
|
||
| 1. On the [**TiDB Instances**](https://tidbcloud.com/tidbs) page of your Organization, click the name of your target instance to go to its overview page. |
There was a problem hiding this comment.
For terminological consistency, it's best to capitalize 'Instance' when referring to a TiDB Cloud Instance, as seen with 'Premium Instance' elsewhere in the document.
| 1. On the [**TiDB Instances**](https://tidbcloud.com/tidbs) page of your Organization, click the name of your target instance to go to its overview page. | |
| 1. On the [**TiDB Instances**](https://tidbcloud.com/tidbs) page of your Organization, click the name of your target Instance to go to its overview page. |
|
|
||
| > **Tip:** | ||
| > | ||
| > You can use the combo box in the upper-left corner to switch between organizations and Premium instances. |
There was a problem hiding this comment.
For consistency, 'Premium Instances' should be capitalized as a proper noun.
| > You can use the combo box in the upper-left corner to switch between organizations and Premium instances. | |
| > You can use the combo box in the upper-left corner to switch between organizations and Premium Instances. |
|
|
||
| 2. Click any SQL Statement in the list to display its detailed execution information. | ||
|
|
||
| 3. Select the time period to be analyzed in the time interval box. Then you can get the execution statistics of SQL statements of all databases in this period. |
There was a problem hiding this comment.
This sentence can be rephrased to be more direct and active, which is recommended by the style guide.1
| 3. Select the time period to be analyzed in the time interval box. Then you can get the execution statistics of SQL statements of all databases in this period. | |
| 3. Select a time range in the time interval box to get the execution statistics of SQL statements for all databases in that period. |
Style Guide References
Footnotes
-
Prefer active voice and avoid unnecessary words. ↩
|
|
||
| 3. Select the time period to be analyzed in the time interval box. Then you can get the execution statistics of SQL statements of all databases in this period. | ||
|
|
||
| 4. (Optional) If you only care about certain databases, you can select the corresponding schema(s) in the next box to filter the results. |
There was a problem hiding this comment.
The phrasing 'if you only care about' is a bit informal, and 'in the next box' is vague. Let's rephrase for better clarity and a more professional tone, as recommended by the style guide.1
| 4. (Optional) If you only care about certain databases, you can select the corresponding schema(s) in the next box to filter the results. | |
| 4. (Optional) If you are interested in only certain databases, you can select the corresponding schema(s) to filter the results. |
Style Guide References
Footnotes
-
Avoid unclear step instructions. ↩
ti-chi-bot
bot
removed
the
missing-translation-status
lilin90
changed the title
|
/cc @Oreoxmt |
|
[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
size/L
Oreoxmt
added
area/tidb-cloud
|
/ok-to-test |
ti-chi-bot
bot
added
ok-to-test
|
/hold |
ti-chi-bot
bot
added
the
do-not-merge/hold
|
@wildpcww: 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. |
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
4 participants
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?