include storage engines in slow query logs and statements summary #21155
Conversation
ti-chi-bot
bot
added
the
first-time-contributor
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
missing-translation-status
|
|
ti-chi-bot
bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @henrybw, 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 updates the documentation for TiDB's slow query log and statement summary features. It introduces descriptions for new fields that have been added to help users identify which storage engine (TiKV or TiFlash) was utilized when executing a query or a category of statements. This enhancement provides valuable context for performance analysis and debugging.
Highlights
- Slow Query Log Documentation: Added documentation for new fields
Storage_from_kvandStorage_from_mppin the slow query log description. These fields indicate whether the statement read data from TiKV or TiFlash, respectively. - Statement Summary Documentation: Added documentation for new fields
STORAGE_KVandSTORAGE_MPPin the statement summary tables description. These fields indicate whether statements in that category read data from TiKV or TiFlash.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request successfully adds documentation for the new storage engine attributes in both the slow query logs and statement summary tables. The changes are well-formatted and adhere to the documentation style guide, enhancing the completeness and clarity of the relevant sections.
| Fields related to storage engines: | ||
|
|
||
| - `Storage_from_kv`: Whether this statement read data from TiKV. | ||
| - `Storage_from_mpp`: Whether this statement read data from TiFlash. |
| Fields related to storage engines: | ||
|
|
||
| - `STORAGE_KV`: Indicates whether the previous execution of SQL statements of this category read data from TiKV. | ||
| - `STORAGE_MPP`: Indicates whether the previous execution of SQL statements of this category read data from TiFlash. |
There was a problem hiding this comment.
This addition effectively documents the new storage engine fields in the statement summary tables. The structure with a heading and list, using backticks for field names, is consistent with the document's existing style and the style guide 12. The descriptions accurately reflect the purpose of these fields in the context of summary tables.
Style Guide References
Footnotes
Oreoxmt
added
translation/doing
ti-chi-bot
bot
removed
the
missing-translation-status
|
@henrybw Could you please invite a tech reviewer? Thanks! |
First-time contributors' checklist
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)?
Do your changes match any of the following descriptions?