Skip to content

premium: add tuning performance #22127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 3, 2025
Merged

premium: add tuning performance #22127

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cf7cc4f
Create tune-performance-premium.md
huoyao1125 Nov 28, 2025
ce4967b
move content from tune-performance-premium.md to tune-performance.md
Oreoxmt Dec 1, 2025
c8c82c4
delete tune-performance-premium.md
Oreoxmt Dec 1, 2025
58bfe0e
fix link
Oreoxmt Dec 1, 2025
a112e42
revise wording
Oreoxmt Dec 1, 2025
50b70eb
Refine wording
lilin90 Dec 2, 2025
88e27a9
Refine wording
lilin90 Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 77 additions & 5 deletions tidb-cloud/tune-performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,41 @@
---
title: Analyze and Tune Performance
summary: Learn how to analyze and tune performance of your TiDB Cloud cluster.
summary: Learn how to analyze and tune performance in TiDB Cloud.
aliases: ['/tidbcloud/index-insight']
---

# Analyze and Tune Performance

<CustomContent plan="starter,essential,dedicated">

TiDB Cloud provides [Slow Query](#slow-query), [Statement Analysis](#statement-analysis), and [Key Visualizer](#key-visualizer) to analyze performance.

- Slow Query lets you search and view all slow queries in your TiDB cluster, and explore the bottlenecks of each slow query by viewing its execution plan, SQL execution information, and other details.
</CustomContent>

<CustomContent plan="premium">

TiDB Cloud provides [Slow Query](#slow-query) and [SQL Statement](#statement-analysis) to analyze performance.

</CustomContent>

- Slow Query lets you search and view all slow queries in your TiDB <CustomContent plan="starter,essential,dedicated">cluster</CustomContent><CustomContent plan="premium">instance</CustomContent>, and explore the bottlenecks of each slow query by viewing its execution plan, SQL execution information, and other details.

- Statement Analysis enables you to directly observe the SQL execution on the page, and easily locate performance problems without querying the system tables.
- <CustomContent plan="starter,essential,dedicated">Statement Analysis</CustomContent><CustomContent plan="premium">SQL Statement</CustomContent> enables you to directly observe the SQL execution on the page, and easily locate performance problems without querying the system tables.

<CustomContent plan="starter,essential,dedicated">

- Key Visualizer helps you observe TiDB's data access patterns and data hotspots.

> **Note:**
>
> Currently, **Key Visualizer** is only available on TiDB Cloud Dedicated clusters.
</CustomContent>

## View the Diagnosis page

<CustomContent plan="starter,essential,dedicated">

1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page.

> **Tip:**
Expand All @@ -28,11 +44,27 @@
2. In the left navigation pane, click **Monitoring** > **Diagnosis**.

</CustomContent>

<CustomContent plan="premium">

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 instances.
2. In the left navigation pane, click **Monitoring**.

</CustomContent>

## Slow Query

By default, SQL queries that take more than 300 milliseconds are considered as slow queries.

To view slow queries in a cluster, perform the following steps:
To view slow queries in a TiDB <CustomContent plan="starter,essential,dedicated">cluster</CustomContent><CustomContent plan="premium">instance</CustomContent>, perform the following steps:

<CustomContent plan="starter,essential,dedicated">

1. Navigate to the [**Diagnosis**](#view-the-diagnosis-page) page of a cluster.

Expand All @@ -42,10 +74,28 @@

4. (Optional) You can filter slow queries based on the target time range, the related databases, and SQL keywords. You can also limit the number of slow queries to be displayed.

</CustomContent>

<CustomContent plan="premium">

1. Navigate and click the **Slow Query** page of a TiDB instance.

2. Click any slow query in the list to display its detailed execution information.

3. (Optional) You can filter slow queries based on the target time range and SQL keywords. You can also limit the number of slow queries to be displayed.

</CustomContent>

The results are displayed in the form of a table, and you can sort the results by different columns.

<CustomContent plan="starter,essential,dedicated">

For more information, see [Slow Queries in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/dashboard-slow-query).

</CustomContent>

<CustomContent plan="starter,essential,dedicated">

## Statement Analysis

To use the statement analysis, perform the following steps:
Expand All @@ -58,8 +108,28 @@

4. (Optional) If you only care about certain databases, you can select the corresponding schema(s) in the next box to filter the results.

</CustomContent>

<CustomContent plan="premium">

## SQL Statement

To use the **SQL Statement** page, perform the following steps:

1. Navigate and click the **SQL Statement** page of a TiDB instance.

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.

4. (Optional) If you only care about certain databases, you can select the corresponding schema(s) in the next box to filter the results.

Check failure on line 125 in tidb-cloud/tune-performance.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.OptionalPlurals] Don't use plurals in parentheses such as in 'schema(s)'.

Raw Output:
{"message": "[PingCAP.OptionalPlurals] Don't use plurals in parentheses such as in 'schema(s)'.", "location": {"path": "tidb-cloud/tune-performance.md", "range": {"start": {"line": 125, "column": 90}}}, "severity": "ERROR"}

</CustomContent>

The results are displayed in the form of a table, and you can sort the results by different columns.

<CustomContent plan="starter,essential,dedicated">

For more information, see [Statement Execution Details in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/dashboard-statement-details).

## Key Visualizer
Expand All @@ -74,6 +144,8 @@

2. Click the **Key Visualizer** tab.

On the **Key Visualizer** page, a large heat map shows changes on access traffic over time. The average values ​​along each axis of the heat map are shown below and on the right side. The left side is the table name, index name and other information.
On the **Key Visualizer** page, a large heat map shows changes on access traffic over time. The average values along each axis of the heat map are shown below and on the right side. The left side is the table name, index name and other information.

For more information, see [Key Visualizer](https://docs.pingcap.com/tidb/stable/dashboard-key-visualizer).

</CustomContent>
Loading