Warn users about the grpc-compression-type config (#20935) #21100
Conversation
Add warnings to users of TiDB about the differences in the supported options for `grpc-compression-type`. Signed-off-by: Xiaoguang Sun <sunxiaoguang@gmail.com>
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, 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!
Summary of Changes
Gemini-code-assist has summarized this pull request, which is an automated cherry-pick of #20935. The primary goal is to update the documentation for the grpc-compression-type configuration in TiKV. A note has been added to warn users that while TiKV supports "none", "deflate", and "gzip", TiDB does not support the "deflate" option for gRPC response messages sent from TiKV to TiDB. The documentation now explicitly recommends using "gzip" if compression is desired for this communication path.
Highlights
- Documentation Update: Added a note to the
tikv-configuration-file.mdexplaining the compatibility difference for thegrpc-compression-typesetting between TiKV and TiDB, specifically that TiDB does not support"deflate". - User Warning: The added note serves as a warning to users configuring gRPC compression between TiKV and TiDB, guiding them to use
"gzip"instead of"deflate".
Changelog
- tikv-configuration-file.md
- Added a note under the
grpc-compression-typedescription to clarify that TiDB does not support the"deflate"option for gRPC response messages from TiKV. - Recommended using
"gzip"for compression between TiKV and TiDB.
- Added a note under the
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request effectively adds an important warning regarding the grpc-compression-type configuration, specifically clarifying the supported compression options when TiKV communicates with TiDB. The added note is clear, well-placed, and significantly enhances user understanding, preventing potential misconfigurations. Excellent work on this clarification!
The review was guided by the TiDB Documentation Style Guide, with a focus on:
- Clarity and Simplicity (Style Guide, lines 14, 21): Ensuring the documentation is easy to understand for TiDB users.
- Conciseness (Style Guide, line 24): Avoiding unnecessary words.
One minor suggestion has been provided in line with these principles.
Summary of Findings
- Minor Conciseness Improvement: A small wording adjustment in the added note (line 146 of
tikv-configuration-file.md) could enhance conciseness. Changing 'if you want to compress' to 'to compress' makes the sentence slightly more direct, aligning with style guide principles (lines 14, 24).
Merge Readiness
This PR adds a valuable warning for users configuring grpc-compression-type. The added note is clear, accurate, and well-placed. I've offered one minor suggestion for conciseness, but the change is otherwise excellent and improves the documentation significantly. The PR appears ready for merging from a content perspective.
As a reviewer, I am not authorized to approve the pull request directly; please ensure it undergoes the standard approval process by other maintainers.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3 participants
This is an automated cherry-pick of #20935
Add warnings to users of TiDB about the differences in the supported options for
grpc-compression-type.First-time contributors' checklist
What is changed, added or deleted? (Required)
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?