astelm
/
grpcurl
mirror of https://github.com/fullstorydev/grpcurl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Expand the documentation of -max-time to clarify this sets the RPC timeout 

Notably, this adds the words "timeout" and "deadline" to this help text which is helpful for discovering this flag.
This commit is contained in:
Michael Diamond 2023-12-08 15:09:14 -08:00 committed by GitHub
parent 7ccaf0a21f
commit 18855a604a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/grpcurl/grpcurl.go
View File

@ -133,9 +133,11 @@ var (
is received for this same period then the connection is closed and the is received for this same period then the connection is closed and the
operation fails.`)) operation fails.`))
maxTime = flags.Float64("max-time", 0, prettify(` maxTime = flags.Float64("max-time", 0, prettify(`
The maximum total time the operation can take, in seconds. This is The maximum total time the operation can take, in seconds. This sets a
useful for preventing batch jobs that use grpcurl from hanging due to timeout on the gRPC context, allowing both client and server to give up
slow or bad network links or due to incorrect stream method usage.`)) after the deadline has past. This is useful for preventing batch jobs
that use grpcurl from hanging due to slow or bad network links or due
to incorrect stream method usage.`))
maxMsgSz = flags.Int("max-msg-sz", 0, prettify(` maxMsgSz = flags.Int("max-msg-sz", 0, prettify(`
The maximum encoded size of a response message, in bytes, that grpcurl The maximum encoded size of a response message, in bytes, that grpcurl
will accept. If not specified, defaults to 4,194,304 (4 megabytes).`)) will accept. If not specified, defaults to 4,194,304 (4 megabytes).`))