Skip to content

Warn users about the grpc-compression-type config (#20935) #21104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ti-chi-bot merged 2 commits into from
Jun 3, 2025
Merged

Warn users about the grpc-compression-type config (#20935) #21104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d59175
Warn users about the grpc-compression-type config
sunxiaoguang May 12, 2025
4840e06
Update tikv-configuration-file.md
qiancai Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tikv-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ This document only describes the parameters that are not included in command-lin

+ The compression algorithm for gRPC messages
+ Optional values: `"none"`, `"deflate"`, `"gzip"`

> **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"`.
Comment on lines +144 to +146
Copy link

@gemini-code-assist gemini-code-assist bot Jun 3, 2025

Choose a reason for hiding this comment

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

medium

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

Suggested change
> **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`.


+ Default value: `"none"`

### `grpc-concurrency`
Expand Down