Skip to content

sys-var: clarify tidb_slow_log_rules syntax/behavior and de-duplicate slow log docs#22567

Open
hfxsd wants to merge 11 commits intopingcap:masterfrom
hfxsd:docs/tidb_slow_log_rules-doc-improve-21324-21337
Open

sys-var: clarify tidb_slow_log_rules syntax/behavior and de-duplicate slow log docs#22567
hfxsd wants to merge 11 commits intopingcap:masterfrom
hfxsd:docs/tidb_slow_log_rules-doc-improve-21324-21337

Conversation

@hfxsd
Copy link
Collaborator

@hfxsd hfxsd commented Mar 16, 2026

What is changed, added or deleted? (Required)

This PR refactors and clarifies tidb_slow_log_rules documentation in:

  • system-variables.md
  • identify-slow-queries.md

Main updates:

  1. Reorganized tidb_slow_log_rules in system-variables.md with clearer structure:

    • Unified syntax and constraints
    • Type constraints
    • Full field table (type/unit/summary)
    • Effective behavior and matching order
    • Examples and usage recommendations
  2. Clarified key behavior/constraints:

    • SESSION/GLOBAL rule capacity and separators
    • SESSION does not support Conn_ID (GLOBAL only)
    • Matching semantics (>= for numeric, = for string/bool)
    • Rule update behavior (SET overwrites, not appends)
    • Fallback to tidb_slow_log_threshold when no effective rules
    • String values cannot contain , / ; (quoted values still not supported)
    • Repeated fields in one rule: last value wins
    • Time-unit distinction (tidb_slow_log_rules time fields are seconds, threshold is milliseconds)
  3. Reduced duplication between docs:

    • Kept rule contract/details in system-variables.md
    • Added metric interpretation section in identify-slow-queries.md
    • Replaced repeated long explanations with cross-references

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file 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

@hfxsd hfxsd added needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. labels Mar 16, 2026
@ti-chi-bot ti-chi-bot bot added the contribution This PR is from a community contributor. label Mar 16, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 the clarity and accuracy of the documentation for the tidb_slow_log_rules system variable. By reorganizing content, clarifying specific behaviors and constraints, and reducing redundancy across related documents, it aims to provide users with a more comprehensive and easier-to-understand guide for configuring and interpreting slow log rules, ultimately improving their ability to identify and troubleshoot performance issues.

Highlights

  • Documentation Refactoring: The documentation for tidb_slow_log_rules has been refactored and clarified across system-variables.md and identify-slow-queries.md to improve user understanding.
  • system-variables.md Enhancements: system-variables.md now features a reorganized structure for tidb_slow_log_rules, including unified syntax, type constraints, a full field table, effective behavior, matching order, and usage examples.
  • Behavior Clarifications: Key behaviors and constraints of tidb_slow_log_rules have been clarified, covering SESSION/GLOBAL rule capacity, Conn_ID support, matching semantics, rule update behavior, fallback mechanisms, string value limitations, handling of repeated fields, and time-unit distinctions.
  • Duplication Reduction: Duplication between documentation files has been reduced by centralizing rule contract details in system-variables.md and adding metric interpretation to identify-slow-queries.md, utilizing cross-references for efficiency.

🧠 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
  • temp.md
    • Added a test file for demonstration purposes.
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.

Footnotes

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

@ti-chi-bot ti-chi-bot bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 16, 2026
@hfxsd hfxsd self-assigned this Mar 16, 2026
@hfxsd hfxsd requested a review from zimulala March 16, 2026 08:48
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request description indicates significant documentation updates for tidb_slow_log_rules. However, the provided changes only consist of adding a temp.md file, which seems unrelated to the stated purpose and appears to be a temporary file. This file should be removed from the pull request to ensure the changes accurately reflect the PR's goal. My review includes a minor suggestion for this file in case its inclusion is intentional.

I am having trouble creating individual review comments. Click here to see my feedback.

temp.md (1)

low

It is a best practice for text files to end with a newline character. This ensures file integrity and proper processing by various tools like cat and git.

This is a test file.

Synced from: pingcap/docs-cn#21337
Target PR: pingcap#22567
AI Provider: gemini

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

[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 hfxsd. 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:

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

@ti-chi-bot ti-chi-bot bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 18, 2026
@ti-chi-bot 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 Mar 18, 2026
@hfxsd hfxsd requested a review from XuHuaiyu March 18, 2026 05:36
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 18, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 18, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-18 10:02:37.458067472 +0000 UTC m=+351284.545724999: ☑️ agreed by zimulala.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants