v8.5.5: include storage engines in slow query logs and statements summary (#21155) #22249

ti-chi-bot · 2025-12-30T06:30:47Z

This is an automated cherry-pick of #21155

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

Document extra attributes added to identify the storage engine in both the statement summary and slow query log.

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

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

…gcap#22248)

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>

gemini-code-assist · 2025-12-30T06:31:02Z

Summary of Changes

Hello @ti-chi-bot, I'm Gemini Code Assist¹! 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 updates the documentation for TiDB's monitoring features, specifically the slow query logs and statement summary tables. It introduces new fields that provide visibility into which storage engines (TiKV or TiFlash) are accessed by queries and details network traffic associated with these operations, enhancing users' ability to analyze query performance and resource consumption.

Highlights

Slow Query Log Enhancements: Documentation has been updated to include new fields (Storage_from_kv, Storage_from_mpp) in the slow query logs, providing insights into whether a statement read data from TiKV or TiFlash.
Statement Summary Table Updates: The statement summary tables now include documented fields (STORAGE_KV, STORAGE_MPP) to indicate storage engine usage, as well as detailed network traffic metrics for TiKV and TiFlash.

🧠 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.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request updates the documentation for slow query logs and statement summary tables to include new fields related to storage engines. The changes are generally good, but I've found a critical issue with merge conflict markers in statement-summary-tables.md that must be resolved. I've also provided suggestions to improve stylistic consistency in both modified files, such as using consistent list markers and formatting descriptions as complete sentences, in line with the repository's style guide.

gemini-code-assist · 2025-12-30T06:32:52Z

statement-summary-tables.md

+<<<<<<< HEAD
+=======
+Fields related to network traffic:
+
+- `SUM_UNPACKED_BYTES_SENT_TIKV_TOTAL`: total bytes sent from SQL statements to TiKV.
+- `SUM_UNPACKED_BYTES_RECEIVED_TIKV_TOTAL`: total bytes received by SQL statements from TiKV.
+- `SUM_UNPACKED_BYTES_SENT_TIKV_CROSS_ZONE`: bytes sent from SQL statements to TiKV across availability zones.
+- `SUM_UNPACKED_BYTES_RECEIVED_TIKV_CROSS_ZONE`: bytes received by SQL statements from TiKV across availability zones.
+- `SUM_UNPACKED_BYTES_SENT_TIFLASH_TOTAL`: total bytes sent from SQL statements to TiFlash, including bytes sent between TiFlash nodes.
+- `SUM_UNPACKED_BYTES_RECEIVED_TIFLASH_TOTAL`: total bytes received by SQL statements from TiFlash, including bytes received between TiFlash nodes.
+- `SUM_UNPACKED_BYTES_SENT_TIFLASH_CROSS_ZONE`: bytes sent from SQL statements to TiFlash across availability zones, including bytes sent between TiFlash nodes across availability zones.
+- `SUM_UNPACKED_BYTES_RECEIVED_TIFLASH_CROSS_ZONE`: bytes received by SQL statements from TiFlash across availability zones, including bytes received between TiFlash nodes across availability zones.
+
+Fields related to storage engines:
+
+- `STORAGE_KV`: introduced in v9.0.0, indicates whether the previous execution of SQL statements of this category read data from TiKV.
+- `STORAGE_MPP`: introduced in v9.0.0, indicates whether the previous execution of SQL statements of this category read data from TiFlash.
+
+>>>>>>> c15b9798eb (include storage engines in slow query logs and statements summary (#21155))


This file contains unresolved merge conflict markers (<<<<<<< HEAD, =======, >>>>>>>) which must be removed. My suggestion below removes them. I've also taken the opportunity to format the new descriptions as complete sentences for better readability and consistency with other descriptions in the file.

Suggested change

<<<<<<< HEAD

=======

Fields related to network traffic:

- `SUM_UNPACKED_BYTES_SENT_TIKV_TOTAL`: total bytes sent from SQL statements to TiKV.

- `SUM_UNPACKED_BYTES_RECEIVED_TIKV_TOTAL`: total bytes received by SQL statements from TiKV.

- `SUM_UNPACKED_BYTES_SENT_TIKV_CROSS_ZONE`: bytes sent from SQL statements to TiKV across availability zones.

- `SUM_UNPACKED_BYTES_RECEIVED_TIKV_CROSS_ZONE`: bytes received by SQL statements from TiKV across availability zones.

- `SUM_UNPACKED_BYTES_SENT_TIFLASH_TOTAL`: total bytes sent from SQL statements to TiFlash, including bytes sent between TiFlash nodes.

- `SUM_UNPACKED_BYTES_RECEIVED_TIFLASH_TOTAL`: total bytes received by SQL statements from TiFlash, including bytes received between TiFlash nodes.

- `SUM_UNPACKED_BYTES_SENT_TIFLASH_CROSS_ZONE`: bytes sent from SQL statements to TiFlash across availability zones, including bytes sent between TiFlash nodes across availability zones.

- `SUM_UNPACKED_BYTES_RECEIVED_TIFLASH_CROSS_ZONE`: bytes received by SQL statements from TiFlash across availability zones, including bytes received between TiFlash nodes across availability zones.

Fields related to storage engines:

- `STORAGE_KV`: introduced in v9.0.0, indicates whether the previous execution of SQL statements of this category read data from TiKV.

- `STORAGE_MPP`: introduced in v9.0.0, indicates whether the previous execution of SQL statements of this category read data from TiFlash.

>>>>>>> c15b9798eb (include storage engines in slow query logs and statements summary (#21155))

Fields related to network traffic:

- `SUM_UNPACKED_BYTES_SENT_TIKV_TOTAL`: The total bytes sent from SQL statements to TiKV.

- `SUM_UNPACKED_BYTES_RECEIVED_TIKV_TOTAL`: The total bytes received by SQL statements from TiKV.

- `SUM_UNPACKED_BYTES_SENT_TIKV_CROSS_ZONE`: The bytes sent from SQL statements to TiKV across availability zones.

- `SUM_UNPACKED_BYTES_RECEIVED_TIKV_CROSS_ZONE`: The bytes received by SQL statements from TiKV across availability zones.

- `SUM_UNPACKED_BYTES_SENT_TIFLASH_TOTAL`: The total bytes sent from SQL statements to TiFlash, including bytes sent between TiFlash nodes.

- `SUM_UNPACKED_BYTES_RECEIVED_TIFLASH_TOTAL`: The total bytes received by SQL statements from TiFlash, including bytes received between TiFlash nodes.

- `SUM_UNPACKED_BYTES_SENT_TIFLASH_CROSS_ZONE`: The bytes sent from SQL statements to TiFlash across availability zones, including bytes sent between TiFlash nodes across availability zones.

- `SUM_UNPACKED_BYTES_RECEIVED_TIFLASH_CROSS_ZONE`: The bytes received by SQL statements from TiFlash across availability zones, including bytes received between TiFlash nodes across availability zones.

Fields related to storage engines:

- `STORAGE_KV`: Introduced in v9.0.0. Indicates whether the previous execution of SQL statements of this category read data from TiKV.

- `STORAGE_MPP`: Introduced in v9.0.0. Indicates whether the previous execution of SQL statements of this category read data from TiFlash.

References

The style guide requires correcting grammar and punctuation. Formatting descriptions as complete sentences improves clarity and readability. ^(link)

identify-slow-queries.md

statement-summary-tables.md

ti-chi-bot · 2025-12-31T03:11:55Z

[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 ask for approval from oreoxmt. 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

wildpcww and others added 3 commits December 29, 2025 09:16

add storage access configuration (pingcap#22232)

68c9380

cloud: update the retention note for the latest automatic backup (pin…

792b582

…gcap#22248)

This is an automated cherry-pick of pingcap#21155

f1383a9

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>

ti-chi-bot mentioned this pull request Dec 30, 2025

include storage engines in slow query logs and statements summary #21155

Merged

16 tasks

gemini-code-assist bot reviewed Dec 30, 2025

View reviewed changes

Oreoxmt changed the title ~~include storage engines in slow query logs and statements summary (#21155)~~ v8.5.5: include storage engines in slow query logs and statements summary (#21155) Dec 31, 2025

Oreoxmt self-assigned this Dec 31, 2025

Oreoxmt reviewed Dec 31, 2025

View reviewed changes

identify-slow-queries.md Outdated Show resolved Hide resolved

Oreoxmt reviewed Dec 31, 2025

View reviewed changes

statement-summary-tables.md Outdated Show resolved Hide resolved

Apply suggestions from code review

ce28bb2

Oreoxmt approved these changes Dec 31, 2025

View reviewed changes

Oreoxmt changed the base branch from release-8.5 to feature/preview-v8.5.5 December 31, 2025 03:12

ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 31, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

v8.5.5: include storage engines in slow query logs and statements summary (#21155) #22249

v8.5.5: include storage engines in slow query logs and statements summary (#21155) #22249

Uh oh!

ti-chi-bot commented Dec 30, 2025

Uh oh!

gemini-code-assist bot commented Dec 30, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Dec 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot bot commented Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

v8.5.5: include storage engines in slow query logs and statements summary (#21155) #22249

Are you sure you want to change the base?

v8.5.5: include storage engines in slow query logs and statements summary (#21155) #22249

Uh oh!

Conversation

ti-chi-bot commented Dec 30, 2025

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

Do your changes match any of the following descriptions?

Uh oh!

gemini-code-assist bot commented Dec 30, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot bot commented Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants