docs: sync session connect attrs docs with tidb#66617#22547
docs: sync session connect attrs docs with tidb#66617#22547jiong-nba wants to merge 2 commits intopingcap:masterfrom
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 |
|
|
Summary of ChangesHello, 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 Highlights
🧠 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
Activity
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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-1behavior, 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_ATTRSdocumentation to includeSession_connect_attrsand 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.
|
/retest |
First-time contributors' checklist
What is changed, added or deleted? (Required)
This PR updates docs according to pingcap/tidb#66617:
Session_connect_attrs(json) to the schema examples ofINFORMATION_SCHEMA.SLOW_QUERYandINFORMATION_SCHEMA.CLUSTER_SLOW_QUERY.performance_schema_session_connect_attrs_size(default/range/-1behavior/truncation/1 MiB hard limit note).Performance_schema_session_connect_attrs_longest_seenPerformance_schema_session_connect_attrs_lostSESSION_CONNECT_ATTRSdoc 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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?