sys-var: clarify tidb_slow_log_rules syntax/behavior and de-duplicate slow log docs (#22567)#22649
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
|
@hfxsd This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. 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 ti-community-infra/tichi repository. |
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for the new tidb_slow_log_rules and tidb_slow_log_max_per_sec system variables, which allow for multi-dimensional slow query log triggering and rate limiting. The review feedback identifies critical merge conflict markers left in the documentation files and provides numerous suggestions to align the text with the style guide, specifically regarding the use of the second person ("you"), active voice, and general grammatical clarity.
|
[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 |
This is an automated cherry-pick of #22567
What is changed, added or deleted? (Required)
This PR refactors and clarifies
tidb_slow_log_rulesdocumentation in:system-variables.mdidentify-slow-queries.mdMain updates:
Reorganized
tidb_slow_log_rulesinsystem-variables.mdwith clearer structure:Clarified key behavior/constraints:
Conn_ID(GLOBAL only)>=for numeric,=for string/bool)tidb_slow_log_thresholdwhen no effective rules,/;(quoted values still not supported)tidb_slow_log_rulestime fields are seconds, threshold is milliseconds)Reduced duplication between docs:
system-variables.mdidentify-slow-queries.mdWhich 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_rulessyntax/behavior and de-duplicate slow log docs docs-cn#21337Do your changes match any of the following descriptions?