Warn users about the grpc-compression-type config (#20935) #21104
Conversation
Add warnings to users of TiDB about the differences in the supported options for `grpc-compression-type`. Signed-off-by: Xiaoguang Sun <[email protected]>
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
Hello! Gemini here, providing a summary of this pull request. This PR, which is an automated cherry-pick of #20935, aims to improve the documentation for the grpc-compression-type configuration parameter in TiKV. The primary goal is to warn users about compatibility differences, specifically that TiDB does not support the "deflate" compression type for gRPC responses sent from TiKV. The changes involve adding a clear note to the TiKV configuration file documentation to guide users towards using "gzip" if they intend to use compression between TiKV and TiDB.
Highlights
- Documentation Update: Adds a note to the
tikv-configuration-file.mdto provide crucial information about thegrpc-compression-typeparameter. - gRPC Compression Compatibility Warning: Explicitly warns users that the
"deflate"option forgrpc-compression-typeis not supported by TiDB and recommends using"gzip"for compression between TiKV and TiDB.
Changelog
- tikv-configuration-file.md
- Added a note under the
grpc-compression-typeparameter description. - The note clarifies that TiDB does not support the
"deflate"compression type. - The note advises users to use
"gzip"for gRPC response compression from TiKV to 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
The pull request adds a note to the tikv-configuration-file.md documentation, warning users about the grpc-compression-type configuration option and its limited support in TiDB. The change is straightforward and addresses a potential source of confusion for users. Overall, the change is good, but I have a few suggestions for improvement.
Summary of Findings
- Clarity and Actionability: The note could be more direct and actionable by using second person and present tense, and by explicitly stating the supported compression types in TiDB.
Merge Readiness
The pull request is almost ready for merging. Addressing the suggestion to rephrase the note for clarity and actionability would improve the user experience. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
| > **Note:** | ||
| > | ||
| > TiDB does not support `"deflate"`. Therefore, if you want to compress gRPC response messages sent from TiKV to TiDB, set this configuration item to `"gzip"`. |
There was a problem hiding this comment.
According to the style guide (lines 22-23), you should write in the second person ("you") when addressing users and prefer present tense (line 23) unless describing historical behavior. Consider rephrasing the note to directly instruct the user on what to do.
Also, it would be helpful to explicitly state that TiDB only supports gzip for gRPC compression, and that none is also supported, but deflate is not. This makes the note more actionable for the user.
Style Guide References
| > **Note:** | |
| > | |
| > TiDB does not support `"deflate"`. Therefore, if you want to compress gRPC response messages sent from TiKV to TiDB, set this configuration item to `"gzip"`. | |
| > **Note:** | |
| > | |
| > TiDB only supports `gzip` and `none` for `grpc-compression-type`. If you want to compress gRPC response messages sent from TiKV to TiDB, set this configuration item to `gzip`. |
|
/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?