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

gRPC Server: Make message size limits configurable. #86982

Merged
merged 3 commits into from Apr 30, 2024
Merged

gRPC Server: Make message size limits configurable. #86982

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
746090c
gRPC Server: Make message size limits configurable.
stevesg Apr 26, 2024
5659bf8
Fix mistake, don't add opts twice
stevesg Apr 30, 2024
81fa0c8
Apply suggestions from code review
stevesg Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions conf/defaults.ini
View file
Open in desktop
Expand Up @@ -107,6 +107,12 @@ key_file =
# this will log the request and response for each unary gRPC call
enable_logging = false

# Maximum size of a message that can be received. If not set, uses the gRPC default (4MiB).
stevesg marked this conversation as resolved.
Show resolved Hide resolved
max_recv_msg_size =

# Maximum size of a message that can be sent. If not set, uses the gRPC default (unlimited).
stevesg marked this conversation as resolved.
Show resolved Hide resolved
max_send_msg_size =

#################################### Database ############################
[database]
# You can configure the database connection by specifying type, host, name, user and password
Expand Down
2 changes: 2 additions & 0 deletions conf/sample.ini
View file
Open in desktop
Expand Up @@ -101,6 +101,8 @@
;use_tls = false
;cert_file =
;key_file =
;max_recv_msg_size =
;max_send_msg_size =

#################################### Database ####################################
[database]
Expand Down
15 changes: 13 additions & 2 deletions pkg/services/grpcserver/service.go
View file
Open in desktop
Expand Up @@ -62,7 +62,10 @@ func ProvideService(cfg *setting.Cfg, features featuremgmt.FeatureToggles, authe
}
}

var opts []grpc.ServerOption
opts := []grpc.ServerOption{
grpc.MaxRecvMsgSize(s.cfg.GRPCServerMaxRecvMsgSize),
grpc.MaxSendMsgSize(s.cfg.GRPCServerMaxSendMsgSize),
}
stevesg marked this conversation as resolved.
Show resolved Hide resolved

// Default auth is admin token check, but this can be overridden by
// services which implement ServiceAuthFuncOverride interface.
Expand All @@ -85,12 +88,20 @@ func ProvideService(cfg *setting.Cfg, features featuremgmt.FeatureToggles, authe
opts = append(opts, grpc.Creds(credentials.NewTLS(cfg.GRPCServerTLSConfig)))
}

if s.cfg.GRPCServerMaxRecvMsgSize > 0 {
opts = append(opts, grpc.MaxRecvMsgSize(s.cfg.GRPCServerMaxRecvMsgSize))
}

if s.cfg.GRPCServerMaxSendMsgSize > 0 {
opts = append(opts, grpc.MaxSendMsgSize(s.cfg.GRPCServerMaxSendMsgSize))
}

s.server = grpc.NewServer(opts...)
return s, nil
}

func (s *gPRCServerService) Run(ctx context.Context) error {
s.logger.Info("Running GRPC server", "address", s.cfg.GRPCServerAddress, "network", s.cfg.GRPCServerNetwork, "tls", s.cfg.GRPCServerTLSConfig != nil)
s.logger.Info("Running GRPC server", "address", s.cfg.GRPCServerAddress, "network", s.cfg.GRPCServerNetwork, "tls", s.cfg.GRPCServerTLSConfig != nil, "max_recv_msg_size", s.cfg.GRPCServerMaxRecvMsgSize, "max_send_msg_size", s.cfg.GRPCServerMaxSendMsgSize)

listener, err := net.Listen(s.cfg.GRPCServerNetwork, s.cfg.GRPCServerAddress)
if err != nil {
Expand Down
12 changes: 8 additions & 4 deletions pkg/setting/setting.go
View file
Open in desktop
Expand Up @@ -470,10 +470,12 @@ type Cfg struct {
RBACSingleOrganization bool

// GRPC Server.
GRPCServerNetwork string
GRPCServerAddress string
GRPCServerTLSConfig *tls.Config
GRPCServerEnableLogging bool // log request and response of each unary gRPC call
GRPCServerNetwork string
GRPCServerAddress string
GRPCServerTLSConfig *tls.Config
GRPCServerEnableLogging bool // log request and response of each unary gRPC call
GRPCServerMaxRecvMsgSize int
GRPCServerMaxSendMsgSize int

CustomResponseHeaders map[string]string

Expand Down Expand Up @@ -1769,6 +1771,8 @@ func readGRPCServerSettings(cfg *Cfg, iniFile *ini.File) error {
cfg.GRPCServerNetwork = valueAsString(server, "network", "tcp")
cfg.GRPCServerAddress = valueAsString(server, "address", "")
cfg.GRPCServerEnableLogging = server.Key("enable_logging").MustBool(false)
cfg.GRPCServerMaxRecvMsgSize = server.Key("max_recv_msg_size").MustInt(0)
cfg.GRPCServerMaxSendMsgSize = server.Key("max_send_msg_size").MustInt(0)
switch cfg.GRPCServerNetwork {
case "unix":
if cfg.GRPCServerAddress != "" {
Expand Down