*: add slow log control variables (tidb_slow_log_rules, tidb_slow_log_max_per_sec) and hint WRITE_SLOW_LOG (#22176)#22517
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Lynn <zimu_xia@126.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
ti-chi-bot
added
lgtm
size/L
|
[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 |
Summary of ChangesHello, 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 significantly enhances TiDB's slow query logging functionality by introducing new control mechanisms. It provides a SQL hint to explicitly log queries and new system variables for fine-grained, rule-based logging and rate limiting. These additions aim to improve the diagnostic capabilities for performance issues, allowing users to capture and analyze specific query behaviors more effectively while preventing log flooding. Highlights
🧠 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. Changelog
Activity
Using Gemini Code AssistThe 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
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 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for new slow log control variables (tidb_slow_log_rules, tidb_slow_log_max_per_sec) and the WRITE_SLOW_LOG hint. It also improves consistency by using "slow query log" throughout the document. The changes are well-written and clear. I've provided a couple of minor suggestions to improve formatting and adhere to the style guide's preference for active voice.
| * GLOBAL scope rules are evaluated only when no SESSION scope rules match: | ||
| * If a GLOBAL rule specifies a `ConnID` that matches the current session `ConnID`, that rule is applied. | ||
| * If a GLOBAL rule does not specify a `ConnID` (acting as a general global rule), that rule is applied. | ||
| * The behavior of displaying this variable via `SHOW VARIABLES`, `SELECT @@GLOBAL.tidb_slow_log_rules`, or `SELECT @@SESSION.tidb_slow_log_rules` is consistent with other system variables. |
There was a problem hiding this comment.
To improve readability and maintain correct Markdown formatting, this list item should have the same indentation as the other items at its level. It seems to be a sub-point of 'If tidb_slow_log_rules is set'.
| * The behavior of displaying this variable via `SHOW VARIABLES`, `SELECT @@GLOBAL.tidb_slow_log_rules`, or `SELECT @@SESSION.tidb_slow_log_rules` is consistent with other system variables. | |
| * The behavior of displaying this variable via `SHOW VARIABLES`, `SELECT @@GLOBAL.tidb_slow_log_rules`, or `SELECT @@SESSION.tidb_slow_log_rules` is consistent with other system variables. |
References
- The style guide requires proper list formatting. This includes consistent indentation for list items at the same level. (link)
|
|
||
| > **Tip:** | ||
| > | ||
| > After enabling `tidb_slow_log_rules`, it is recommended to also configure [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-new-in-v900) to limit the slow query log output rate and prevent rule-based slow query logging from being triggered too frequently. |
There was a problem hiding this comment.
To follow the style guide's preference for active voice and direct address, this sentence can be rephrased to be more direct.
| > After enabling `tidb_slow_log_rules`, it is recommended to also configure [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-new-in-v900) to limit the slow query log output rate and prevent rule-based slow query logging from being triggered too frequently. | |
| > After enabling `tidb_slow_log_rules`, also configure [`tidb_slow_log_max_per_sec`](#tidb_slow_log_max_per_sec-new-in-v900) to limit the slow query log output rate and prevent rule-based slow query logging from being triggered too frequently. |
|
@ti-chi-bot: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
3 participants
This is an automated cherry-pick of #22176
First-time contributors' checklist
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)?
tidb_slow_log_rules,tidb_slow_log_max_per_sec) and hintWRITE_SLOW_LOGdocs-cn#21009Do your changes match any of the following descriptions?