docs: refresh TopSQL docs and screenshots#22559
docs: refresh TopSQL docs and screenshots#22559yibin87 wants to merge 8 commits intopingcap:masterfrom
Conversation
ti-chi-bot
bot
added
the
missing-translation-status
Summary of ChangesHello, 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 significantly updates the documentation for the TiDB Dashboard Top SQL feature. The changes aim to provide users with a more accurate and comprehensive guide to leveraging Top SQL's advanced capabilities, including multi-dimensional analysis for TiKV instances and improved resource consumption insights. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
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
size/L
![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 provides a comprehensive update to the Top SQL documentation, aligning it with the latest features and improving overall clarity. The changes are well-executed, particularly the addition of details on new metrics and the refreshed screenshots. I have offered two minor suggestions to enhance readability and consistency, in line with the repository's documentation style guide.
| When a TiKV instance is selected and **TiKV Network IO collection (multi-dimensional)** is enabled, the `Order By` drop-down list shows `Order By CPU`, `Order By Network`, and `Order By Logical IO`. | ||
|
|
||
| Select a TiKV instance, and then select **By TABLE** or **By DB**: | ||
|  | ||
|
|
||
|  |
There was a problem hiding this comment.
For better readability and to properly introduce both screenshots, consider combining the introduction for both the Order By and aggregation dimension dropdowns into a single sentence. This makes the connection between the text and the images clearer.
| When a TiKV instance is selected and **TiKV Network IO collection (multi-dimensional)** is enabled, the `Order By` drop-down list shows `Order By CPU`, `Order By Network`, and `Order By Logical IO`. | |
| Select a TiKV instance, and then select **By TABLE** or **By DB**: | |
|  | |
|  | |
| When a TiKV instance is selected and **TiKV Network IO collection (multi-dimensional)** is enabled, you can see more options in the `Order By` and aggregation dimension drop-down lists. | |
|  | |
|  |
References
- The style guide emphasizes clarity and simplicity. The suggested change improves the flow by introducing both screenshots with a single, clear sentence. (link)
dashboard/top-sql.md
Outdated
| ## Frequently asked questions | ||
|
|
||
| **1. Top SQL cannot be enabled and the UI displays "required component NgMonitoring is not started"**. | ||
| **1. Top SQL cannot be enabled and the UI displays "required component NgMonitoring is not started".** |
There was a problem hiding this comment.
For consistency with other FAQ items, which are phrased as questions, consider rephrasing this statement into a question. This improves the logical flow of the FAQ section.
| **1. Top SQL cannot be enabled and the UI displays "required component NgMonitoring is not started".** | |
| **1. Why can't I enable Top SQL, and why does the UI display "required component NgMonitoring is not started"?** |
References
- The style guide mentions maintaining a logical flow. Phrasing all FAQ items as questions improves consistency and logical flow. (link)
yibin87
changed the title
yibin87
changed the title
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
hfxsd
added
translation/from-docs-cn
3 participants
What is changed, added or deleted? (Required)
dashboard/top-sql.mdto match the currentpingcap/tidb-dashboardbehavior for TopSQL.5/20/100,Order By CPU/Order By Network/Order By Logical IO, TiKVBy Query/By Table/By DB/By Region, and the enable/disable behavior for TiKV network IO collection.Order Bydropdown and the TopSQL settings drawer for enabling TiKV Network IO collection.Monitor TopSQLsection intidb-cloud/tidb-cloud-clinic.mdso it describes multi-dimensional hotspot analysis instead of CPU-only analysis.Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?