-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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
Remove duplication of GRPC configuration #5447
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // Copyright (c) 2021 Gitpod GmbH. All rights reserved. | ||
| // Licensed under the GNU Affero General Public License (AGPL). | ||
| // See License-AGPL.txt in the project root for license information. | ||
|
|
||
| package grpc | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware" | ||
| grpc_opentracing "github.com/grpc-ecosystem/go-grpc-middleware/tracing/opentracing" | ||
| "github.com/opentracing/opentracing-go" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/backoff" | ||
| "google.golang.org/grpc/keepalive" | ||
| ) | ||
|
|
||
| // maxMsgSize use 16MB as the default message size limit. | ||
| // grpc library default is 4MB | ||
| const maxMsgSize = 1024 * 1024 * 16 | ||
|
|
||
| // DefaultClientOptions returns the default grpc client connection options | ||
| func DefaultClientOptions() []grpc.DialOption { | ||
| bfConf := backoff.DefaultConfig | ||
| bfConf.MaxDelay = 5 * time.Second | ||
|
|
||
| return []grpc.DialOption{ | ||
| grpc.WithUnaryInterceptor(grpc_opentracing.UnaryClientInterceptor(grpc_opentracing.WithTracer(opentracing.GlobalTracer()))), | ||
| grpc.WithStreamInterceptor(grpc_opentracing.StreamClientInterceptor(grpc_opentracing.WithTracer(opentracing.GlobalTracer()))), | ||
| grpc.WithBlock(), | ||
| grpc.WithConnectParams(grpc.ConnectParams{ | ||
| Backoff: bfConf, | ||
| }), | ||
| grpc.WithKeepaliveParams(keepalive.ClientParameters{ | ||
| Time: 5 * time.Second, | ||
| Timeout: time.Second, | ||
| PermitWithoutStream: true, | ||
| }), | ||
| grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxMsgSize)), | ||
| } | ||
| } | ||
|
|
||
| // DefaultServerOptions returns the default ServerOption sets options for internal components | ||
| func DefaultServerOptions() []grpc.ServerOption { | ||
| return ServerOptionsWithInterceptors([]grpc.StreamServerInterceptor{}, []grpc.UnaryServerInterceptor{}) | ||
| } | ||
|
|
||
| // ServerOptionsWithInterceptors returns the default ServerOption sets options for internal components with additional interceptors. | ||
| // By default, Interceptors for OpenTracing (grpc_opentracing) are added as the last one. | ||
| func ServerOptionsWithInterceptors(stream []grpc.StreamServerInterceptor, unary []grpc.UnaryServerInterceptor) []grpc.ServerOption { | ||
| stream = append(stream, grpc_opentracing.StreamServerInterceptor(grpc_opentracing.WithTracer(opentracing.GlobalTracer()))) | ||
| unary = append(unary, grpc_opentracing.UnaryServerInterceptor(grpc_opentracing.WithTracer(opentracing.GlobalTracer()))) | ||
|
|
||
| return []grpc.ServerOption{ | ||
| // terminate the connection if the client pings more than once every 2 seconds | ||
| grpc.KeepaliveEnforcementPolicy(keepalive.EnforcementPolicy{ | ||
| MinTime: 2 * time.Second, | ||
| PermitWithoutStream: true, | ||
| }), | ||
| grpc.MaxRecvMsgSize(maxMsgSize), | ||
| // We don't know how good our cients are at closing connections. If they don't close them properly | ||
| // we'll be leaking goroutines left and right. Closing Idle connections should prevent that. | ||
| grpc.KeepaliveParams(keepalive.ServerParameters{ | ||
| MaxConnectionIdle: 30 * time.Minute, | ||
| }), | ||
| grpc.StreamInterceptor(grpc_middleware.ChainStreamServer(stream...)), | ||
| grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer(unary...)), | ||
| } | ||
| } | ||
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main reason to adjust this value is related to some observed metrics that could indicate the current value is low.
grpc_server_handled_total{grpc_code="ResourceExhausted",grpc_method="StartWorkspace",grpc_service="wsman.WorkspaceManager",grpc_type="unary"} 8