blob: 5fc0ee3da53bc49930ce3c688c78e41d24af702d [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
2 *
3 * Copyright 2017 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19// Package backoff implement the backoff strategy for gRPC.
20//
21// This is kept in internal until the gRPC project decides whether or not to
22// allow alternative backoff strategies.
23package backoff
24
25import (
26 "time"
27
khenaidoo26721882021-08-11 17:42:52 -040028 grpcbackoff "google.golang.org/grpc/backoff"
Scott Baker2c1c4822019-10-16 11:02:41 -070029 "google.golang.org/grpc/internal/grpcrand"
30)
31
32// Strategy defines the methodology for backing off after a grpc connection
33// failure.
Scott Baker2c1c4822019-10-16 11:02:41 -070034type Strategy interface {
35 // Backoff returns the amount of time to wait before the next retry given
36 // the number of consecutive failures.
37 Backoff(retries int) time.Duration
38}
39
khenaidoo26721882021-08-11 17:42:52 -040040// DefaultExponential is an exponential backoff implementation using the
41// default values for all the configurable knobs defined in
42// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.
43var DefaultExponential = Exponential{Config: grpcbackoff.DefaultConfig}
Scott Baker2c1c4822019-10-16 11:02:41 -070044
45// Exponential implements exponential backoff algorithm as defined in
46// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.
47type Exponential struct {
khenaidoo26721882021-08-11 17:42:52 -040048 // Config contains all options to configure the backoff algorithm.
49 Config grpcbackoff.Config
Scott Baker2c1c4822019-10-16 11:02:41 -070050}
51
52// Backoff returns the amount of time to wait before the next retry given the
53// number of retries.
54func (bc Exponential) Backoff(retries int) time.Duration {
55 if retries == 0 {
khenaidoo26721882021-08-11 17:42:52 -040056 return bc.Config.BaseDelay
Scott Baker2c1c4822019-10-16 11:02:41 -070057 }
khenaidoo26721882021-08-11 17:42:52 -040058 backoff, max := float64(bc.Config.BaseDelay), float64(bc.Config.MaxDelay)
Scott Baker2c1c4822019-10-16 11:02:41 -070059 for backoff < max && retries > 0 {
khenaidoo26721882021-08-11 17:42:52 -040060 backoff *= bc.Config.Multiplier
Scott Baker2c1c4822019-10-16 11:02:41 -070061 retries--
62 }
63 if backoff > max {
64 backoff = max
65 }
66 // Randomize backoff delays so that if a cluster of requests start at
67 // the same time, they won't operate in lockstep.
khenaidoo26721882021-08-11 17:42:52 -040068 backoff *= 1 + bc.Config.Jitter*(grpcrand.Float64()*2-1)
Scott Baker2c1c4822019-10-16 11:02:41 -070069 if backoff < 0 {
70 return 0
71 }
72 return time.Duration(backoff)
73}