server/grpc: add configurable graceful shutdown timeout (v4 & v5)#163
Open
Grantmartin2002 wants to merge 2 commits intogo-micro:mainfrom
Open
server/grpc: add configurable graceful shutdown timeout (v4 & v5)#163Grantmartin2002 wants to merge 2 commits intogo-micro:mainfrom
Grantmartin2002 wants to merge 2 commits intogo-micro:mainfrom
Conversation
The gRPC server previously had a hardcoded 1-second timeout after calling GracefulStop() before forcefully terminating connections with Stop(). This is insufficient for applications with long-lived gRPC streams that need time to drain during shutdown. Add a GracefulStopTimeout option that allows users to configure how long the server waits for in-flight requests to complete. Defaults to 1 second for backwards compatibility. Fixes go-micro#162 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GracefulStopTimeoutserver option to configure how long the gRPC server waits for in-flight requests to complete during graceful shutdowntime.Secondfor backwards compatibilityProblem
The gRPC server has a hardcoded 1-second timeout after calling
GracefulStop()before forcefully callingStop(). For applications with long-lived gRPC streams (e.g., server-side streaming in Kubernetes), this causes active streams to be terminated withECONNRESETduring rolling updates, even whenterminationGracePeriodSecondsallows for graceful draining.Usage
Changes
v4/server/grpc/options.go— addGracefulStopTimeoutoption and context keyv4/server/grpc/grpc.go— read option, fall back totime.Secondv5/server/grpc/options.go— samev5/server/grpc/grpc.go— sameFixes #162