docs: add tidb_enable_connection_event_log system variable - #23278
docs: add tidb_enable_connection_event_log system variable#23278gengliqi wants to merge 4 commits into
Conversation
|
[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 |
ti-chi-bot
Bot
added
missing-translation-status
![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 introduces documentation for the new system variable tidb_enable_connection_event_log in system-variables.md. The review feedback suggests improving the documentation by removing redundant lines for boolean variables, enhancing sentence structure for parallel phrasing, and adopting the second-person perspective ("your workload") to align with the style guide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
@YangKeao: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this: Instructions 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. |
qiancai
added
translation/from-docs-cn
ti-chi-bot
Bot
removed
the
missing-translation-status
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
📝 WalkthroughWalkthroughThe documentation adds the ChangesConnection event log variable
Estimated code review effort: 1 (Trivial) | ~2 minutes Mergeability Score: ⚪ Minimal · up to This documentation-only change adds the system variable description and is merge-ready after normal review; the remaining wording cleanup is minor and non-blocking. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| - Type: Boolean | ||
| - Default value: `OFF` | ||
| - This variable controls whether to write successful client login and logout events to the TiDB log. | ||
| - If your workload frequently creates and closes connections, enabling this variable can generate a large number of log entries. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Replace the ambiguous workload warning.
Vale flags “a large number of” as ambiguous. State the impact more directly.
| - If your workload frequently creates and closes connections, enabling this variable can generate a large number of log entries. | |
| - If your workload frequently creates and closes connections, enabling this variable can significantly increase the number of log entries. |
As per path instructions: “For every actionable issue, provide a GitHub committable suggestion block containing the exact replacement text whenever the fix can be safely and completely applied to contiguous lines in the diff.”
🧰 Tools
🪛 GitHub Check: vale
[warning] 2175-2175:
[vale] reported by reviewdog 🐶
[PingCAP.Ambiguous] Consider using a clearer word than 'a large number of' because it may cause confusion.
Raw Output:
{"message":"[PingCAP.Ambiguous] Consider using a clearer word than 'a large number of' because it may cause confusion.","location":{"path":"system-variables.md","range":{"start":{"line":2175,"column":99},"end":{"line":2175,"column":116}}},"severity":"INFO","code":{"value":"PingCAP.Ambiguous"}}
Sources: Path instructions, Linters/SAST tools
3 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Add tidb_enable_connection_event_log system variable
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?
Summary by CodeRabbit
tidb_enable_connection_event_logsystem variable.