docs: roll back v8.5.6 TopSQL multidimensional docs#22910
Open
yibin87 wants to merge 3 commits into
Open
Conversation
Signed-off-by: yibin87 <huyibin@pingcap.com>
|
[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 |
ti-chi-bot
Bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors the Top SQL documentation to focus on CPU overhead, removing references to multi-dimensional metrics such as Network and Logical IO across several files. It also updates the TiKV configuration documentation to include new storage.max-ts parameters for v9.0.0 and adjusts versioning information for various features. Reviewer feedback focuses on maintaining terminology consistency (specifically using 'Top SQL' with a space), improving grammatical flow, avoiding passive voice in instructions, and ensuring that links to configuration templates point to version-specific branches rather than the master branch.
| <!-- markdownlint-disable MD001 --> | ||
|
|
||
| The TiKV configuration file supports more options than command-line parameters. You can find the default configuration file in [etc/config-template.toml](https://github.com/tikv/tikv/blob/release-8.5/etc/config-template.toml) and rename it to `config.toml`. | ||
| The TiKV configuration file supports more options than command-line parameters. You can find the default configuration file in [etc/config-template.toml](https://github.com/tikv/tikv/blob/master/etc/config-template.toml) and rename it to `config.toml`. |
Contributor
There was a problem hiding this comment.
Technical accuracy: The link to the configuration template has been changed from the version-specific branch (release-8.5) to master. For versioned documentation, it is better to point to the corresponding release branch to ensure users see the correct default configuration for their version.
Suggested change
| The TiKV configuration file supports more options than command-line parameters. You can find the default configuration file in [etc/config-template.toml](https://github.com/tikv/tikv/blob/master/etc/config-template.toml) and rename it to `config.toml`. | |
| The TiKV configuration file supports more options than command-line parameters. You can find the default configuration file in [etc/config-template.toml](https://github.com/tikv/tikv/blob/release-8.5/etc/config-template.toml) and rename it to `config.toml`. |
|  | ||
|
|
||
| If the chart is out of date, click **Refresh** to refresh once, or select the data auto-refresh frequency from the **Refresh** drop-down list. | ||
| If you are unsure of which TiDB or TiKV instance to observe, you can select an arbitrary instance. Also, when the cluster CPU load is extremely unbalanced, you can first use Grafana charts to determine the specific instance you want to observe. |
Contributor
There was a problem hiding this comment.
Grammar: "unsure of which" can be simplified to "unsure which" for better flow and conciseness.
Suggested change
| If you are unsure of which TiDB or TiKV instance to observe, you can select an arbitrary instance. Also, when the cluster CPU load is extremely unbalanced, you can first use Grafana charts to determine the specific instance you want to observe. | |
| If you are unsure which TiDB or TiKV instance to observe, you can select an arbitrary instance. Also, when the cluster CPU load is extremely unbalanced, you can first use Grafana charts to determine the specific instance you want to observe. |
|  | ||
|
|
||
| 6. In the `By Query` view, click a row in the table to view the execution plan details for that type of SQL. | ||
| 6. View the CPU resource usage by table or database level to quickly identify resource usage at a higher level. Currently, only TiKV instances are supported. |
Contributor
There was a problem hiding this comment.
Grammar: "by table or database level" should be "at the table or database level".
Suggested change
| 6. View the CPU resource usage by table or database level to quickly identify resource usage at a higher level. Currently, only TiKV instances are supported. | |
| 6. View the CPU resource usage at the table or database level to quickly identify resource usage at a higher level. Currently, only TiKV instances are supported. |
|
|
||
| 1. Visit the [Top SQL page](#access-the-page). | ||
| 2. Click the gear icon in the upper right corner to open the settings pane and disable the **Enable Feature** switch. | ||
| 1. Visit [Top SQL page](#access-the-page). |
Contributor
There was a problem hiding this comment.
Missing article: "Visit the [Top SQL page]" for consistency with other steps in this document.
Suggested change
| 1. Visit [Top SQL page](#access-the-page). | |
| 1. Visit the [Top SQL page](#access-the-page). |
| **4. What is the meaning of "Other Statements"?** | ||
|
|
||
| `Others` represents the summary result of all non-Top N records under the current sort dimension. You can use it to understand how much of the total workload comes from the Top N records. | ||
| "Other Statement" counts the total CPU overhead of all non-Top 5 statements. With this information, you can learn the CPU overhead contributed by the Top 5 statements compared with the overall. |
Contributor
There was a problem hiding this comment.
Consistency: Use "Other Statements" (plural) to match the heading in line 136.
Suggested change
| "Other Statement" counts the total CPU overhead of all non-Top 5 statements. With this information, you can learn the CPU overhead contributed by the Top 5 statements compared with the overall. | |
| "Other Statements" counts the total CPU overhead of all non-Top 5 statements. With this information, you can learn the CPU overhead contributed by the Top 5 statements compared with the overall. |
| 2. From the organization list, select your target organization. The clusters in the selected project are displayed. | ||
|
|
||
| 3. Click the name of your target TiDB Cloud Dedicated cluster. The cluster overview page is displayed, where you can view detailed information about your cluster, including: | ||
| 3. Click the name of your target cluster. The cluster overview page is displayed, where you can view detailed information about your cluster, including: |
Contributor
There was a problem hiding this comment.
Avoid passive voice ("is displayed"). Using an active verb makes the instruction clearer and more direct.
Suggested change
| 3. Click the name of your target cluster. The cluster overview page is displayed, where you can view detailed information about your cluster, including: | |
| 3. Click the name of your target cluster to open the cluster overview page, where you can view detailed information about your cluster, including: |
| - Advanced Metrics | ||
| - Top Slow Queries (only supported when the TiDB version of the cluster is v8.1.1 or later, v7.5.4 or later) | ||
| - Top SQL (only supported when the TiDB version of the cluster is v8.1.1 or later, v7.5.4 or later) | ||
| - TopSQL (only supported when the TiDB version of the cluster is v8.1.1 or later, v7.5.4 or later) |
Contributor
There was a problem hiding this comment.
Consistency: The feature name is "Top SQL" (with a space). Please use the consistent term throughout the documentation.
Suggested change
| - TopSQL (only supported when the TiDB version of the cluster is v8.1.1 or later, v7.5.4 or later) | |
| - Top SQL (only supported when the TiDB version of the cluster is v8.1.1 or later, v7.5.4 or later) |
Comment on lines
+94
to
+108
| ## Monitor TopSQL | ||
|
|
||
| TiDB Cloud Clinic provides Top SQL information to help you visually analyze the most resource-intensive queries on a specific TiDB or TiKV node over a period of time. By default, Top SQL continuously collects CPU load data. For TiKV nodes, if TiKV network IO collection is enabled, you can also inspect `Network Bytes` and `Logical IO Bytes`, and analyze hotspots by `Query`, `Table`, `DB`, or `Region`. This helps you identify and troubleshoot performance issues across multiple resource dimensions, not just CPU. | ||
| TiDB Cloud Clinic provides TopSQL information, enabling you to monitor and visually explore the CPU overhead of each SQL statement in your database in real time. This helps you optimize and resolve database performance issues. | ||
|
|
||
| To view Top SQL, take the following steps: | ||
| To view TopSQL, take the following steps: | ||
|
|
||
| 1. In the [TiDB Cloud Clinic console](https://clinic.pingcap.com/), navigate to the **Cluster** page of a cluster. | ||
|
|
||
| 2. Click **Top SQL**. | ||
| 2. Click **TopSQL**. | ||
|
|
||
| 3. Select a specific TiDB or TiKV node to observe its workload. You can use the time picker or select a time range in the chart to refine your analysis. | ||
| 3. Select a specific TiDB or TiKV instance to observe its load. You can use the time picker or select a time range in the chart to refine your analysis. | ||
|
|
||
| 4. Analyze the charts and tables displayed by Top SQL. Depending on the selected node and enabled metrics, you can use `Order By` and the available aggregation dimensions to inspect CPU, network, or logical I/O hotspots. | ||
| 4. Analyze the charts and tables displayed by TopSQL. | ||
|
|
||
| For more information, see [Top SQL in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/top-sql). | ||
| For more information, see [TopSQL in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/top-sql). |
Contributor
There was a problem hiding this comment.
Consistency: The term "Top SQL" is used consistently throughout the documentation. Changing it to "TopSQL" here introduces inconsistency. Also, please remove the trailing space at the end of line 108.
Suggested change
| ## Monitor TopSQL | |
| TiDB Cloud Clinic provides Top SQL information to help you visually analyze the most resource-intensive queries on a specific TiDB or TiKV node over a period of time. By default, Top SQL continuously collects CPU load data. For TiKV nodes, if TiKV network IO collection is enabled, you can also inspect `Network Bytes` and `Logical IO Bytes`, and analyze hotspots by `Query`, `Table`, `DB`, or `Region`. This helps you identify and troubleshoot performance issues across multiple resource dimensions, not just CPU. | |
| TiDB Cloud Clinic provides TopSQL information, enabling you to monitor and visually explore the CPU overhead of each SQL statement in your database in real time. This helps you optimize and resolve database performance issues. | |
| To view Top SQL, take the following steps: | |
| To view TopSQL, take the following steps: | |
| 1. In the [TiDB Cloud Clinic console](https://clinic.pingcap.com/), navigate to the **Cluster** page of a cluster. | |
| 2. Click **Top SQL**. | |
| 2. Click **TopSQL**. | |
| 3. Select a specific TiDB or TiKV node to observe its workload. You can use the time picker or select a time range in the chart to refine your analysis. | |
| 3. Select a specific TiDB or TiKV instance to observe its load. You can use the time picker or select a time range in the chart to refine your analysis. | |
| 4. Analyze the charts and tables displayed by Top SQL. Depending on the selected node and enabled metrics, you can use `Order By` and the available aggregation dimensions to inspect CPU, network, or logical I/O hotspots. | |
| 4. Analyze the charts and tables displayed by TopSQL. | |
| For more information, see [Top SQL in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/top-sql). | |
| For more information, see [TopSQL in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/top-sql). | |
| ## Monitor Top SQL\n\nTiDB Cloud Clinic provides Top SQL information, enabling you to monitor and visually explore the CPU overhead of each SQL statement in your database in real time. This helps you optimize and resolve database performance issues.\n\nTo view Top SQL, take the following steps:\n\n1. In the [TiDB Cloud Clinic console](https://clinic.pingcap.com/), navigate to the **Cluster** page of a cluster.\n\n2. Click **Top SQL**.\n\n3. Select a specific TiDB or TiKV instance to observe its load. You can use the time picker or select a time range in the chart to refine your analysis.\n\n4. Analyze the charts and tables displayed by Top SQL.\n\nFor more information, see [Top SQL in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/top-sql). |
Signed-off-by: yibin87 <huyibin@pingcap.com>
Signed-off-by: yibin87 <huyibin@pingcap.com>
ti-chi-bot
Bot
added
size/L
qiancai
approved these changes
May 19, 2026
[LGTM Timeline notifier]Timeline:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted? (Required)
releases/release-8.5.6.mdWhich 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?