Skip to content

Commit

Permalink
doc: update keepalive.md to add why (grpc#3993)
Browse files Browse the repository at this point in the history
  • Loading branch information
menghanl authored and davidkhala committed Dec 7, 2020
1 parent f969b91 commit 75e1c22
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Documentation/keepalive.md
Expand Up @@ -8,6 +8,17 @@ activity on the connection.
For how to configure keepalive, see
https://godoc.org/google.golang.org/grpc/keepalive for the options.

## Why do I need this?

Keepalive can be useful to detect TCP level connection failures. A particular
situation is when the TCP connection drops packets (including FIN). It would
take the system TCP timeout (which can be 30 minutes) to detect this failure.
Keepalive would allow gRPC to detect this failure much sooner.

Another usage is (as the name suggests) to keep the connection alive. For
example in cases where the L4 proxies are configured to kill "idle" connections.
Sending pings would make the connections not "idle".

## What should I set?

It should be sufficient for most users to set [client
Expand Down

0 comments on commit 75e1c22

Please sign in to comment.