Create Statement Insight by huoyao1125 · Pull Request #23486 · pingcap/docs

huoyao1125 · 2026-08-10T12:37:02Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

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)?

This PR is translated from:
Other reference link(s):

AI agent involvement

The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Summary by CodeRabbit

Documentation
- Added a preview-marked Statement Insight page to the TiDB Cloud Premium documentation.
- Documented access steps, historical data collection, filters, RU and latency metrics, execution details, dimensional summaries, leaderboards, and trend charts.
- Added information about limitations, data retention, and FAQs comparing Statement Insight with Top RU and billing data.
- Added Statement Insight to the Monitor and Alert table of contents.

ti-chi-bot · 2026-08-10T12:37:15Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign qiancai for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

coderabbitai · 2026-08-10T12:37:51Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

The PR adds a Statement Insight documentation page and links it from the TiDB Cloud Premium table of contents. The page covers access, filters, metrics, charts, limitations, and FAQs.

Changes

Statement Insight

Layer / File(s)	Summary
Statement Insight access and navigation `tidb-cloud/statement-insight.md`, `TOC-tidb-cloud-premium.md`	The page documents preview availability, historical data behavior, prerequisites, and console access. The table of contents adds a Preview-labeled link under Monitor and Alert.
Statement Insight analysis and FAQs `tidb-cloud/statement-insight.md`	The page documents filters, SQL Overview metrics, dimensional summaries, trend charts, data freshness, aggregation limits, and differences from Top RU and billing data.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: area/tidb-cloud

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description retains the template but provides no change summary, version selection, links, or other required information.	Add the change summary, select the applicable TiDB version, and complete the reference, AI involvement, and change-type sections.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the main change: adding Statement Insight documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch huoyao1125-patch-2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1179b5d9-f382-43f8-9471-a12f0a5f6811

📥 Commits

Reviewing files that changed from the base of the PR and between 84444c6 and 2f87b4e.

📒 Files selected for processing (1)

tidb-cloud/Statement Insight

coderabbitai · 2026-08-10T12:38:36Z

@@ -0,0 +1 @@
+


📐 Maintainability & Code Quality | 🟠 Major | 🏗️ Heavy lift

Add the requested documentation content before merging.

tidb-cloud/Statement Insight contains only blank lines. This change does not implement the PR objective to add “Create Statement Insight” documentation.

Adds the Statement Insight (Preview) page for TiDB Cloud Premium, covering multi-dimensional RU/latency/execution-count analysis by DB User, SQL Type, and SQL Digest, and registers it in the Premium navigation.

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: fd15e83c-9a79-42d0-80f2-c0583b5bcd3d

📥 Commits

Reviewing files that changed from the base of the PR and between 2f87b4e and 2aec0d9.

📒 Files selected for processing (2)

TOC-tidb-cloud-premium.md
tidb-cloud/statement-insight.md

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b6daf13b-b7fb-43bb-83dc-4ef9186dcf2e

📥 Commits

Reviewing files that changed from the base of the PR and between 2aec0d9 and 1000511.

📒 Files selected for processing (1)

tidb-cloud/statement-insight.md

CLAassistant · 2026-08-14T09:51:16Z

All committers have signed the CLA.

qiancai · 2026-08-17T07:43:33Z

+
+## Analyze RU consumption, latency, and execution counts
+
+The **SQL Overview** panel summarizes the SQL statements that match your filters, sliced by multiple dimensions. For each dimension, you can switch the **Measured by** control to change which metric drives both the leaderboard and the trend chart:


There is no SQL Overview panel. Do you mean "Top Contributors" panel?

Co-authored-by: Grace Cai <qqzczy@126.com>

huoyao1125

applied

qiancai · 2026-08-17T09:42:01Z

+- **SQL Type**: filter by SQL statement type, such as `SELECT`, `INSERT`, or `UPDATE`.
+- **Database**: filter by the database that the SQL statements ran against.
+- **Table**: filter by the table that the SQL statements ran against.
+- **SQL Digest**: filter by a specific SQL digest.


There is no filter for SQL Digest. Do you mean a keyword filter?

Suggested change

- **SQL Digest**: filter by a specific SQL digest.

- **Keyword**: filter by a keyword that matches the SQL digest text.

qiancai · 2026-08-17T09:45:52Z

+- **Mean RU**: total RU divided by execution count.
+- **Total latency**: the sum of execution latency.
+- **Mean latency**: total latency divided by execution count.
+- **Execution count**: the number of times the SQL statements were executed.


missing “Plans Count”

qiancai · 2026-08-17T09:49:07Z

+
+### Trend charts
+
+The trend chart shows how the selected metric changes over time for the dimension you are viewing.


Suggested change

The trend chart shows how the selected metric changes over time for the dimension you are viewing.

The **Resource Usage Over Time** trend chart shows how the selected metric changes over time for the dimension you are viewing.

qiancai · 2026-08-17T09:49:52Z

+
+### Why is there no data, or only a short time range of data, in Statement Insight?
+
+Statement Insight does not backfill historical data. Data starts accumulating from the moment the feature is enabled on your instance, and the available time range grows over time. If you enabled the feature recently, this is expected behavior, not a sign of missing or broken data.


How do customers enable this feature?

Create Statement Insight

2f87b4e

ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 10, 2026

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

docs(tidb-cloud): add Statement Insight user guide

2aec0d9

Adds the Statement Insight (Preview) page for TiDB Cloud Premium, covering multi-dimensional RU/latency/execution-count analysis by DB User, SQL Type, and SQL Digest, and registers it in the Premium navigation.

ti-chi-bot Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 10, 2026

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread tidb-cloud/statement-insight.md Outdated

Update statement-insight.md

1000511

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread tidb-cloud/statement-insight.md Outdated

qiancai reviewed Aug 17, 2026

View reviewed changes

Comment thread tidb-cloud/statement-insight.md Outdated

qiancai reviewed Aug 17, 2026

View reviewed changes

huoyao1125 and others added 8 commits August 17, 2026 16:04

Update statement-insight.md

ceaca25

Apply suggestion from @qiancai

a15ca7b

Co-authored-by: Grace Cai <qqzczy@126.com>

Update statement-insight.md

c76acf4

Update statement-insight.md

bd9ad7a

Update statement-insight.md

a7e10c9

Update TOC-tidb-cloud-byoc.md

29167f1

Update TOC-tidb-cloud-byoc.md

23e19ba

Update TOC-tidb-cloud-essential.md

f2c04fe

qiancai reviewed Aug 17, 2026

View reviewed changes

Comment thread tidb-cloud/statement-insight.md Outdated

qiancai reviewed Aug 17, 2026

View reviewed changes

Comment thread tidb-cloud/statement-insight.md Outdated

huoyao1125 and others added 3 commits August 17, 2026 17:07

Update statement-insight.md

32d3ec3

Apply suggestion from @qiancai

76f1b0b

Co-authored-by: Grace Cai <qqzczy@126.com>

Apply suggestion from @qiancai

eee3413

Co-authored-by: Grace Cai <qqzczy@126.com>

huoyao1125 commented Aug 17, 2026

View reviewed changes

Update tune-performance.md

8539240

ti-chi-bot Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 17, 2026

qiancai reviewed Aug 17, 2026

View reviewed changes

qiancai self-assigned this Aug 17, 2026

qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Aug 17, 2026

ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Aug 17, 2026


		## Analyze RU consumption, latency, and execution counts

		The SQL Overview panel summarizes the SQL statements that match your filters, sliced by multiple dimensions. For each dimension, you can switch the Measured by control to change which metric drives both the leaderboard and the trend chart:

	- SQL Digest: filter by a specific SQL digest.
	- Keyword: filter by a keyword that matches the SQL digest text.


		### Trend charts

		The trend chart shows how the selected metric changes over time for the dimension you are viewing.

	The trend chart shows how the selected metric changes over time for the dimension you are viewing.
	The Resource Usage Over Time trend chart shows how the selected metric changes over time for the dimension you are viewing.


		### Why is there no data, or only a short time range of data, in Statement Insight?

		Statement Insight does not backfill historical data. Data starts accumulating from the moment the feature is enabled on your instance, and the available time range grows over time. If you enabled the feature recently, this is expected behavior, not a sign of missing or broken data.

Uh oh!

Conversation

huoyao1125 commented Aug 10, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

AI agent involvement

Do your changes match any of the following descriptions?

Summary by CodeRabbit

Uh oh!

ti-chi-bot Bot commented Aug 10, 2026

Uh oh!

coderabbitai Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CLAassistant commented Aug 14, 2026 • edited by pingcap-cla-assistant Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

qiancai Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

huoyao1125 left a comment

Choose a reason for hiding this comment

Uh oh!

qiancai Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

qiancai Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

qiancai Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

qiancai Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

huoyao1125 commented Aug 10, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

CLAassistant commented Aug 14, 2026 •

edited by pingcap-cla-assistant Bot

Loading