Skip to content

server/grpc: add configurable graceful shutdown timeout (v4 & v5) #163

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

Open
Grantmartin2002 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

server/grpc: add configurable graceful shutdown timeout (v4 & v5) #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf89d7b
server/grpc: add configurable graceful shutdown timeout (v4 & v5)
Apr 9, 2026
554e442
style: shorten GracefulStopTimeout comment to match existing style
Apr 10, 2026
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
7 changes: 6 additions & 1 deletion v4/server/grpc/grpc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,9 +983,14 @@ func (g *grpcServer) Start() error {
close(exit)
}()

gracefulTimeout := time.Second
if v, ok := g.opts.Context.Value(gracefulStopTimeoutKey{}).(time.Duration); ok && v > 0 {
gracefulTimeout = v
}

select {
case <-exit:
case <-time.After(time.Second):
case <-time.After(gracefulTimeout):
g.srv.Stop()
}

Expand Down
8 changes: 8 additions & 0 deletions v4/server/grpc/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"crypto/tls"
"net"
"time"

"go-micro.dev/v4/broker"
"go-micro.dev/v4/codec"
Expand All @@ -22,6 +23,7 @@ type maxMsgSizeKey struct{}
type maxConnKey struct{}
type tlsAuth struct{}
type grpcServerKey struct{}
type gracefulStopTimeoutKey struct{}

// gRPC Codec to be used to encode/decode requests for a given content type.
func Codec(contentType string, c encoding.Codec) server.Option {
Expand Down Expand Up @@ -72,6 +74,12 @@ func MaxMsgSize(s int) server.Option {
return setServerOption(maxMsgSizeKey{}, s)
}

// GracefulStopTimeout set the timeout for the server to stop gracefully
// before forcefully stopping. Default is 1 second.
func GracefulStopTimeout(d time.Duration) server.Option {
return setServerOption(gracefulStopTimeoutKey{}, d)
}

func newOptions(opt ...server.Option) server.Options {
opts := server.Options{
Codecs: make(map[string]codec.NewCodec),
Expand Down
7 changes: 6 additions & 1 deletion v5/server/grpc/grpc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,9 +983,14 @@ func (g *grpcServer) Start() error {
close(exit)
}()

gracefulTimeout := time.Second
if v, ok := g.opts.Context.Value(gracefulStopTimeoutKey{}).(time.Duration); ok && v > 0 {
gracefulTimeout = v
}

select {
case <-exit:
case <-time.After(time.Second):
case <-time.After(gracefulTimeout):
g.srv.Stop()
}

Expand Down
8 changes: 8 additions & 0 deletions v5/server/grpc/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"crypto/tls"
"net"
"time"

"go-micro.dev/v5/broker"
"go-micro.dev/v5/codec"
Expand All @@ -22,6 +23,7 @@ type maxMsgSizeKey struct{}
type maxConnKey struct{}
type tlsAuth struct{}
type grpcServerKey struct{}
type gracefulStopTimeoutKey struct{}

// gRPC Codec to be used to encode/decode requests for a given content type.
func Codec(contentType string, c encoding.Codec) server.Option {
Expand Down Expand Up @@ -72,6 +74,12 @@ func MaxMsgSize(s int) server.Option {
return setServerOption(maxMsgSizeKey{}, s)
}

// GracefulStopTimeout set the timeout for the server to stop gracefully
// before forcefully stopping. Default is 1 second.
func GracefulStopTimeout(d time.Duration) server.Option {
return setServerOption(gracefulStopTimeoutKey{}, d)
}

func newOptions(opt ...server.Option) server.Options {
opts := server.Options{
Codecs: make(map[string]codec.NewCodec),
Expand Down