Skip to content
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

Jump to bottom

allow configuring grpc max connection age #9657

Merged
merged 1 commit into from
Jul 31, 2024
Merged

allow configuring grpc max connection age #9657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 changelog/unreleased/add-grpc-max-connection-age-env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Enhancement: Allow configuring grpc max connection age

We added a GRPC_MAX_CONNECTION_AGE env var that allows limiting the lifespan of connections. A closed connection triggers grpc clients to do a new DNS lookup to pick up new IPs.

https://github.com/owncloud/ocis/pull/9657
24 changes: 24 additions & 0 deletions ocis-pkg/service/grpc/keepalive.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package grpc

import (
"math"
"os"
"time"
)

const (
_serverMaxConnectionAgeEnv = "GRPC_MAX_CONNECTION_AGE"

// same default as grpc
infinity = time.Duration(math.MaxInt64)
Copy link
Collaborator

Choose a reason for hiding this comment

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

LOL. math.MaxInt64 is NOT infinity because math.MaxInt64 + 1 is bigger.

Copy link
Contributor

Choose a reason for hiding this comment

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

LOL, nerdy but ur correct

_defaultMaxConnectionAge = infinity
)

// GetMaxConnectionAge returns the maximum grpc connection age.
func GetMaxConnectionAge() time.Duration {
d, err := time.ParseDuration(os.Getenv(_serverMaxConnectionAgeEnv))
if err != nil {
return _defaultMaxConnectionAge
}
return d
}
9 changes: 7 additions & 2 deletions ocis-pkg/service/grpc/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import (
"go-micro.dev/v4"
"go-micro.dev/v4/client"
"go-micro.dev/v4/server"
"google.golang.org/grpc"
"google.golang.org/grpc/keepalive"
)

// Service simply wraps the go-micro grpc service.
Expand All @@ -24,6 +26,9 @@ type Service struct {
func NewServiceWithClient(client client.Client, opts ...Option) (Service, error) {
var mServer server.Server
sopts := newOptions(opts...)
keepaliveParams := grpc.KeepaliveParams(keepalive.ServerParameters{
MaxConnectionAge: GetMaxConnectionAge(), // this forces clients to reconnect after 30 seconds, triggering a new DNS lookup to pick up new IPs
})
tlsConfig := &tls.Config{}

if sopts.TLSEnabled {
Expand All @@ -44,9 +49,9 @@ func NewServiceWithClient(client client.Client, opts ...Option) (Service, error)
}
}
tlsConfig.Certificates = []tls.Certificate{cert}
mServer = mgrpcs.NewServer(mgrpcs.AuthTLS(tlsConfig))
mServer = mgrpcs.NewServer(mgrpcs.Options(keepaliveParams), mgrpcs.AuthTLS(tlsConfig))
} else {
mServer = mgrpcs.NewServer()
mServer = mgrpcs.NewServer(mgrpcs.Options(keepaliveParams))
}

mopts := []micro.Option{
Expand Down