Skip to content

docs: support logging session connect attrs to slow query log #22547

Merged
ti-chi-bot[bot] merged 15 commits intopingcap:masterfrom
jiong-nba:codex/docs-sync-tidb-pr-66617
Mar 30, 2026
Merged

docs: support logging session connect attrs to slow query log #22547
ti-chi-bot[bot] merged 15 commits intopingcap:masterfrom
jiong-nba:codex/docs-sync-tidb-pr-66617

Conversation

@jiong-nba
Copy link
Copy Markdown
Contributor

@jiong-nba jiong-nba commented Mar 10, 2026

First-time contributors' checklist

What is changed, added or deleted? (Required)

This PR updates docs according to pingcap/tidb#66617:

  • Add Session_connect_attrs (json) to the schema examples of INFORMATION_SCHEMA.SLOW_QUERY and INFORMATION_SCHEMA.CLUSTER_SLOW_QUERY.
  • Add the system variable doc for performance_schema_session_connect_attrs_size (default/range/-1 behavior/truncation/1 MiB hard limit note).
  • Add status variable docs:
    • Performance_schema_session_connect_attrs_longest_seen
    • Performance_schema_session_connect_attrs_lost
  • Update SESSION_CONNECT_ATTRS doc with size limit and truncation behavior.

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

Copilot AI review requested due to automatic review settings March 10, 2026 03:04
@ti-chi-bot ti-chi-bot bot added the first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. label Mar 10, 2026
@pingcap-cla-assistant
Copy link
Copy Markdown

pingcap-cla-assistant bot commented Mar 10, 2026

CLA assistant check
All committers have signed the CLA.

@ti-chi-bot ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Mar 10, 2026
@gemini-code-assist
Copy link
Copy Markdown
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 synchronizes the documentation with recent changes in TiDB related to session connection attributes. It ensures that users have up-to-date information regarding the Session_connect_attrs column in slow query logs, the configuration options for connection attribute size limits, and new status variables for monitoring attribute usage and truncation.

Highlights

  • Schema Updates: The Session_connect_attrs column (json type) has been added to the schema examples for INFORMATION_SCHEMA.SLOW_QUERY and INFORMATION_SCHEMA.CLUSTER_SLOW_QUERY.
  • System Variable Documentation: Detailed documentation for the performance_schema_session_connect_attrs_size system variable has been added, covering its default value, range, behavior when set to -1, truncation logic, and a 1 MiB hard limit note.
  • Status Variable Documentation: New status variables, Performance_schema_session_connect_attrs_longest_seen and Performance_schema_session_connect_attrs_lost, have been documented.
  • SESSION_CONNECT_ATTRS Update: The SESSION_CONNECT_ATTRS documentation has been updated to include information about size limits and truncation behavior for connection attributes.

🧠 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
  • information-schema/information-schema-slow-query.md
    • Added Session_connect_attrs column to the INFORMATION_SCHEMA.SLOW_QUERY schema example.
    • Updated row count in the INFORMATION_SCHEMA.SLOW_QUERY schema example.
    • Added Session_connect_attrs column to the INFORMATION_SCHEMA.CLUSTER_SLOW_QUERY schema example.
    • Updated row count in the INFORMATION_SCHEMA.CLUSTER_SLOW_QUERY schema example.
  • performance-schema/performance-schema-session-connect-attrs.md
    • Added a new section titled 'Size limit and truncation' to the SESSION_CONNECT_ATTRS documentation.
    • Detailed the performance_schema_session_connect_attrs_size system variable's default, range, and -1 behavior.
    • Explained the truncation mechanism for excess attributes and the 1 MiB hard limit for handshake packets.
  • status-variables.md
    • Added documentation for the Performance_schema_session_connect_attrs_longest_seen status variable.
    • Added documentation for the Performance_schema_session_connect_attrs_lost status variable.
  • system-variable-reference.md
    • Inserted a new reference entry for performance_schema_session_connect_attrs_size.
  • system-variables.md
    • Added a new section detailing the performance_schema_session_connect_attrs_size system variable.
    • Provided information on its scope, persistence, hint applicability, type, default value, range, unit, and behavior.
    • Included a note about the 1 MiB hard limit for handshake connection attributes.
Activity
  • No human activity has occurred on this pull request yet.
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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 10, 2026
Copy link
Copy Markdown
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

This pull request updates documentation to introduce and describe new features related to session connection attributes. It adds the Session_connect_attrs column to the information_schema.SLOW_QUERY table, documents the performance_schema_session_connect_attrs_size system variable for controlling attribute size limits and truncation, and introduces two new status variables (Performance_schema_session_connect_attrs_longest_seen and Performance_schema_session_connect_attrs_lost) for monitoring these attributes.

Note: Security Review has been skipped due to the limited scope of the PR.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates TiDB documentation to reflect newly supported session connection attributes exposure and sizing/truncation behavior, syncing with upstream TiDB changes from pingcap/tidb#66617.

Changes:

  • Document the new global system variable performance_schema_session_connect_attrs_size, including -1 behavior, truncation semantics, and the 1 MiB handshake hard limit.
  • Add new status variables for monitoring observed/lost session connection attributes sizes.
  • Extend schema examples and SESSION_CONNECT_ATTRS documentation to include Session_connect_attrs and size/truncation details.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
system-variables.md Adds documentation for performance_schema_session_connect_attrs_size (defaults/range/truncation and hard limit note).
system-variable-reference.md Adds cross-references for the new system variable entry.
status-variables.md Documents new status variables tracking longest seen and truncated/lost session connect attrs.
performance-schema/performance-schema-session-connect-attrs.md Adds a dedicated “Size limit and truncation” section tied to the new system variable and hard limit.
information-schema/information-schema-slow-query.md Updates SLOW_QUERY and CLUSTER_SLOW_QUERY schema examples to include Session_connect_attrs and updates row counts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jiong-nba
Copy link
Copy Markdown
Contributor Author

/retest

@hfxsd hfxsd added translation/doing This PR's assignee is translating this PR. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. and removed missing-translation-status This PR does not have translation status info. labels Mar 11, 2026
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 25, 2026

@zhaoshangzi: 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.

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 25, 2026

@zhaoshangzi: 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.

@jiong-nba
Copy link
Copy Markdown
Contributor Author

/retest

@hfxsd hfxsd self-assigned this Mar 26, 2026
@jiong-nba jiong-nba changed the title docs: sync session connect attrs docs with tidb#66617 docs: support logging session connect attrs to slow query log Mar 26, 2026
github-actions bot pushed a commit to hfxsd/pingcap-docsite-preview that referenced this pull request Mar 27, 2026
Comment thread performance-schema/performance-schema-session-connect-attrs.md
github-actions bot pushed a commit to hfxsd/pingcap-docsite-preview that referenced this pull request Mar 27, 2026
github-actions bot pushed a commit to hfxsd/pingcap-docsite-preview that referenced this pull request Mar 27, 2026
github-actions bot pushed a commit to hfxsd/pingcap-docsite-preview that referenced this pull request Mar 27, 2026
Copy link
Copy Markdown
Contributor

@yibin87 yibin87 left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 30, 2026

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

Details

In response to this:

LGTM

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.

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 30, 2026

@nolouch: 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.

@hfxsd hfxsd requested a review from lilin90 March 30, 2026 07:37
Comment thread performance-schema/performance-schema-session-connect-attrs.md Outdated
Comment thread system-variables.md Outdated
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Copy link
Copy Markdown
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

/lgtm

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 30, 2026
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Mar 30, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 30, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-30 07:46:47.132235817 +0000 UTC m=+164812.337595874: ☑️ agreed by lilin90.
  • 2026-03-30 07:55:29.951846807 +0000 UTC m=+165335.157206864: ☑️ agreed by hfxsd.

@hfxsd
Copy link
Copy Markdown
Collaborator

hfxsd commented Mar 30, 2026

/retest

@hfxsd
Copy link
Copy Markdown
Collaborator

hfxsd commented Mar 30, 2026

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 30, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 the approved label Mar 30, 2026
@ti-chi-bot ti-chi-bot bot merged commit 5c91200 into pingcap:master Mar 30, 2026
12 checks passed
@hfxsd hfxsd added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Apr 17, 2026
ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Apr 17, 2026
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22775.
But this PR has conflicts, please resolve them!

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

Labels

approved first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/M Denotes a PR that changes 30-99 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.

8 participants