Skip to content

docs: add tidb_enable_connection_event_log system variable - #21811

Open
gengliqi wants to merge 4 commits into
pingcap:masterfrom
gengliqi:connection_event_log
Open

docs: add tidb_enable_connection_event_log system variable#21811
gengliqi wants to merge 4 commits into
pingcap:masterfrom
gengliqi:connection_event_log

Conversation

@gengliqi

@gengliqi gengliqi commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

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 (in Chinese).

  • 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)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference 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

Summary by CodeRabbit

  • 新功能

    • 新增系统变量 tidb_enable_connection_event_log,用于控制是否将客户端成功登录和退出事件写入 TiDB 日志。
    • 该变量支持全局作用域和集群持久化,默认值为 OFF,不支持通过 SET_VAR Hint 设置。
  • 文档

    • 补充高频建立或关闭连接可能产生大量日志的说明。

gengliqi added 2 commits July 15, 2026 14:17
u
Signed-off-by: gengliqi <gengliqiii@gmail.com>
u
Signed-off-by: gengliqi <gengliqiii@gmail.com>
@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 15, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 15, 2026

Copy link
Copy Markdown

@YangKeao: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In 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 qiancai added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jul 16, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 16, 2026
@qiancai qiancai self-assigned this Jul 16, 2026
@qiancai qiancai added needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. labels Jul 16, 2026
u
Signed-off-by: gengliqi <gengliqiii@gmail.com>
@ti-chi-bot

ti-chi-bot Bot commented Jul 16, 2026

Copy link
Copy Markdown

[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 qiancai. 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

Comment thread system-variables.md Outdated
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 9288336c-f292-44ca-9cb0-323a29580174

📥 Commits

Reviewing files that changed from the base of the PR and between 5a1d9cb and 5aae76b.

📒 Files selected for processing (1)
  • system-variables.md

📝 Walkthrough

Walkthrough

新增系统变量 tidb_enable_connection_event_log 的文档说明。该变量控制客户端成功登录和退出事件是否写入 TiDB 日志。

Changes

连接事件日志变量

Layer / File(s) Summary
变量定义与日志行为说明
system-variables.md
新增 tidb_enable_connection_event_log 的 GLOBAL 作用域、集群持久化方式、默认值 OFFSET_VAR Hint 限制。文档说明启用后会记录客户端成功登录和退出事件。

Estimated code review effort: 1(简单) | ~5 分钟

Mergeability Score: ⚪ Minimal · up to 5aae7

This documentation-only change adds a system variable entry and has no actionable merge-blocking risk remaining after normal checks and review.

Suggested reviewers: qiancai, lilin90, ti-chi-bot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了新增系统变量文档的主要变更,内容清晰且简洁。
Description check ✅ Passed 描述包含变更内容、适用版本和必需检查项,整体信息基本完整。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Labels

needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. 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.

3 participants