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
client: add WithConnectParams to configure connection backoff and timeout #2960
Merged
Merged
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
32275fc
Implement missing pieces for connection backoff.
easwars f8b4003
Add comment for exported var DefaultExponential.
easwars 0f7db76
Handle review comments.
easwars 0115f00
Make vet happy.
easwars dea6444
vets and comments
easwars f5998d1
Missed during merge conflict resolution.
easwars 3fce38e
Review comments.
easwars e1a1470
Make vet happy.
easwars ebebd7d
Change a weird character masquerading as a space.
easwars cc7872c
Review comments.
easwars File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/* | ||
* | ||
* Copyright 2019 gRPC authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
* | ||
*/ | ||
|
||
// Package backoff provides configuration options for backoff. | ||
// | ||
// More details can be found at: | ||
// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md. | ||
package backoff | ||
|
||
import "time" | ||
|
||
// Config defines the configuration options for backoff. | ||
// | ||
// This API is EXPERIMENTAL. | ||
type Config struct { | ||
// BaseDelay is the amount of time to backoff after the first failure. | ||
BaseDelay time.Duration | ||
// Multiplier is the factor with which to multiply backoffs after a | ||
// failed retry. Should ideally be greater than 1. | ||
Multiplier float64 | ||
// Jitter is the factor with which backoffs are randomized. | ||
Jitter float64 | ||
// MaxDelay is the upper bound of backoff delay. | ||
MaxDelay time.Duration | ||
} | ||
|
||
// DefaultConfig is a backoff configuration with the default values specfied | ||
// at https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md. | ||
// | ||
// This should be useful for callers who want to configure backoff with | ||
// non-default values only for a subset of the options. | ||
// | ||
// This API is EXPERIMENTAL. | ||
var DefaultConfig = Config{ | ||
BaseDelay: 1.0 * time.Second, | ||
Multiplier: 1.6, | ||
Jitter: 0.2, | ||
MaxDelay: 120 * time.Second, | ||
} |
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 |
---|---|---|
|
@@ -24,11 +24,12 @@ import ( | |
"net" | ||
"time" | ||
|
||
"google.golang.org/grpc/backoff" | ||
"google.golang.org/grpc/balancer" | ||
"google.golang.org/grpc/credentials" | ||
"google.golang.org/grpc/grpclog" | ||
"google.golang.org/grpc/internal" | ||
"google.golang.org/grpc/internal/backoff" | ||
internalbackoff "google.golang.org/grpc/internal/backoff" | ||
"google.golang.org/grpc/internal/envconfig" | ||
"google.golang.org/grpc/internal/transport" | ||
"google.golang.org/grpc/keepalive" | ||
|
@@ -47,7 +48,7 @@ type dialOptions struct { | |
|
||
cp Compressor | ||
dc Decompressor | ||
bs backoff.Strategy | ||
bs internalbackoff.Strategy | ||
block bool | ||
insecure bool | ||
timeout time.Duration | ||
|
@@ -246,28 +247,47 @@ func WithServiceConfig(c <-chan ServiceConfig) DialOption { | |
}) | ||
} | ||
|
||
// WithConnectParams configures the dialer to use the provided ConnectParams. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this the best place to document our defaults? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Made the comments a bit more verbose. |
||
// | ||
// The backoff configuration specified as part of the ConnectParams overrides | ||
// all defaults specified in | ||
// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md. Consider | ||
// using the backoff.DefaultConfig as a base, in cases where you want to | ||
// override only a subset of the backoff configuration. | ||
// | ||
// This API is EXPERIMENTAL. | ||
func WithConnectParams(p ConnectParams) DialOption { | ||
return newFuncDialOption(func(o *dialOptions) { | ||
o.bs = internalbackoff.Exponential{Config: p.Backoff} | ||
o.minConnectTimeout = func() time.Duration { | ||
return p.MinConnectTimeout | ||
} | ||
}) | ||
} | ||
|
||
// WithBackoffMaxDelay configures the dialer to use the provided maximum delay | ||
// when backing off after failed connection attempts. | ||
// | ||
// Deprecated: use WithConnectParams instead. Will be supported throughout 1.x. | ||
func WithBackoffMaxDelay(md time.Duration) DialOption { | ||
return WithBackoffConfig(BackoffConfig{MaxDelay: md}) | ||
} | ||
|
||
// WithBackoffConfig configures the dialer to use the provided backoff | ||
// parameters after connection failures. | ||
// | ||
// Use WithBackoffMaxDelay until more parameters on BackoffConfig are opened up | ||
// for use. | ||
//Deprecated: use WithConnectParams instead. Will be supported throughout 1.x. | ||
func WithBackoffConfig(b BackoffConfig) DialOption { | ||
return withBackoff(backoff.Exponential{ | ||
MaxDelay: b.MaxDelay, | ||
}) | ||
bc := backoff.DefaultConfig | ||
bc.MaxDelay = b.MaxDelay | ||
return withBackoff(internalbackoff.Exponential{Config: bc}) | ||
} | ||
|
||
// withBackoff sets the backoff strategy used for connectRetryNum after a failed | ||
// connection attempt. | ||
// | ||
// This can be exported if arbitrary backoff strategies are allowed by gRPC. | ||
func withBackoff(bs backoff.Strategy) DialOption { | ||
func withBackoff(bs internalbackoff.Strategy) DialOption { | ||
return newFuncDialOption(func(o *dialOptions) { | ||
o.bs = bs | ||
}) | ||
|
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.
Please move this comment to the whole package level instead.
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.
Done.
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.
I was actually referring to the "EXPERIMENTAL" part. Please mark the whole file as experimental. Following the same wording as
resolver/resolver.go
: