Warn users about the grpc-compression-type config (#20935) #21101
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
As gemini-code-assist, I've reviewed this pull request. The main purpose of this PR is to enhance the documentation for the grpc-compression-type configuration parameter within the TiKV configuration file. It specifically adds a note to inform users about the compatibility differences between TiKV and TiDB regarding the supported compression types for gRPC communication between them. This PR appears to be an automated cherry-pick from a previous change, likely to propagate the documentation update to multiple release branches.
Highlights
- Documentation Update: Adds a significant note to the
tikv-configuration-file.mddocumentation. - Configuration Guidance: Provides a clear warning that the
"deflate"compression option forgrpc-compression-typeis not supported by TiDB for communication from TiKV, recommending"gzip"instead for this specific use case.
Changelog
- tikv-configuration-file.md
- Added a note under the description of the
grpc-compression-typeparameter (inserted around original line 143). - The added note clarifies that TiDB does not support the
"deflate"compression type for gRPC response messages from TiKV and advises using"gzip"if compression is desired for this path.
- Added a note under the description of 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 documentation, warning users about the grpc-compression-type configuration option and its limited support in TiDB. The change is straightforward and addresses a potential misconfiguration issue. However, I have a few suggestions to improve clarity and adherence to the style guide.
Summary of Findings
- Clarity and User Guidance: The note could benefit from a brief explanation of why TiDB doesn't support 'deflate' to provide more context for the user.
- Style Guide Adherence: The note should be rephrased to use the second person ('you') when addressing users, as per the documentation style guide.
Merge Readiness
The pull request is almost ready for merging. Addressing the clarity and style guide issues would improve the overall quality of the documentation. I am unable to approve this pull request, and recommend that another reviewer approves this code before merging.
|
/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?