Documentation ¶
Index ¶
- Constants
- Variables
- func GetBackoffForNextSchedule(cronSchedule string, startTime time.Time, closeTime time.Time) time.Duration
- func GetBackoffForNextScheduleInSeconds(cronSchedule string, startTime time.Time, closeTime time.Time) int32
- func IgnoreErrors(errorsToExclude []error) func(error) bool
- func JitDuration(duration time.Duration, coefficient float64) time.Duration
- func JitFloat64(input float64, coefficient float64) float64
- func JitInt64(input int64, coefficient float64) int64
- func Retry(operation Operation, policy RetryPolicy, isRetryable IsRetryable) error
- func ValidateSchedule(cronSchedule string) error
- type Clock
- type ConcurrentRetrier
- type ExponentialRetryPolicy
- func (p *ExponentialRetryPolicy) ComputeNextDelay(elapsedTime time.Duration, numAttempts int) time.Duration
- func (p *ExponentialRetryPolicy) SetBackoffCoefficient(backoffCoefficient float64)
- func (p *ExponentialRetryPolicy) SetExpirationInterval(expirationInterval time.Duration)
- func (p *ExponentialRetryPolicy) SetInitialInterval(initialInterval time.Duration)
- func (p *ExponentialRetryPolicy) SetMaximumAttempts(maximumAttempts int)
- func (p *ExponentialRetryPolicy) SetMaximumInterval(maximumInterval time.Duration)
- type IsRetryable
- type Operation
- type Retrier
- type RetryPolicy
- type TwoPhaseRetryPolicy
Constants ¶
const NoBackoff = time.Duration(-1)
NoBackoff is used to represent backoff when no cron backoff is needed
const (
// NoInterval represents Maximim interval
NoInterval = 0
)
Variables ¶
var SystemClock = systemClock{}
SystemClock implements Clock interface that uses time.Now().
Functions ¶
func GetBackoffForNextSchedule ¶ added in v0.6.0
func GetBackoffForNextSchedule(cronSchedule string, startTime time.Time, closeTime time.Time) time.Duration
GetBackoffForNextSchedule calculates the backoff time for the next run given a cronSchedule, workflow start time and workflow close time
func GetBackoffForNextScheduleInSeconds ¶ added in v0.6.0
func GetBackoffForNextScheduleInSeconds(cronSchedule string, startTime time.Time, closeTime time.Time) int32
GetBackoffForNextScheduleInSeconds calculates the backoff time in seconds for the next run given a cronSchedule and current time
func IgnoreErrors ¶
IgnoreErrors can be used as IsRetryable handler for Retry function to exclude certain errors from the retry list
func JitDuration ¶ added in v0.9.3
JitDuration return random duration from (1-coefficient)*duration to (1+coefficient)*duration, inclusive, exclusive
func JitFloat64 ¶ added in v0.9.3
JitFloat64 return random number from (1-coefficient)*input to (1+coefficient)*input, inclusive, exclusive
func JitInt64 ¶ added in v0.9.3
JitInt64 return random number from (1-coefficient)*input to (1+coefficient)*input, inclusive, exclusive
func Retry ¶
func Retry(operation Operation, policy RetryPolicy, isRetryable IsRetryable) error
Retry function can be used to wrap any call with retry logic using the passed in policy
func ValidateSchedule ¶ added in v0.6.0
ValidateSchedule validates a cron schedule spec
Types ¶
type Clock ¶
Clock used by ExponentialRetryPolicy implementation to get the current time. Mainly used for unit testing
type ConcurrentRetrier ¶
ConcurrentRetrier is used for client-side throttling. It determines whether to throttle outgoing traffic in case downstream backend server rejects requests due to out-of-quota or server busy errors.
func NewConcurrentRetrier ¶
func NewConcurrentRetrier(retryPolicy RetryPolicy) *ConcurrentRetrier
NewConcurrentRetrier returns an instance of concurrent backoff retrier.
func (*ConcurrentRetrier) Failed ¶
func (c *ConcurrentRetrier) Failed()
Failed marks client request failed because backend is busy.
func (*ConcurrentRetrier) Succeeded ¶
func (c *ConcurrentRetrier) Succeeded()
Succeeded marks client request succeeded.
func (*ConcurrentRetrier) Throttle ¶
func (c *ConcurrentRetrier) Throttle()
Throttle Sleep if there were failures since the last success call.
type ExponentialRetryPolicy ¶
type ExponentialRetryPolicy struct {
// contains filtered or unexported fields
}
ExponentialRetryPolicy provides the implementation for retry policy using a coefficient to compute the next delay. Formula used to compute the next delay is: initialInterval * math.Pow(backoffCoefficient, currentAttempt)
func NewExponentialRetryPolicy ¶
func NewExponentialRetryPolicy(initialInterval time.Duration) *ExponentialRetryPolicy
NewExponentialRetryPolicy returns an instance of ExponentialRetryPolicy using the provided initialInterval
func (*ExponentialRetryPolicy) ComputeNextDelay ¶
func (p *ExponentialRetryPolicy) ComputeNextDelay(elapsedTime time.Duration, numAttempts int) time.Duration
ComputeNextDelay returns the next delay interval. This is used by Retrier to delay calling the operation again
func (*ExponentialRetryPolicy) SetBackoffCoefficient ¶
func (p *ExponentialRetryPolicy) SetBackoffCoefficient(backoffCoefficient float64)
SetBackoffCoefficient sets the coefficient used by ExponentialRetryPolicy to compute next delay for each retry All retries are computed using the following formula: initialInterval * math.Pow(backoffCoefficient, currentAttempt)
func (*ExponentialRetryPolicy) SetExpirationInterval ¶
func (p *ExponentialRetryPolicy) SetExpirationInterval(expirationInterval time.Duration)
SetExpirationInterval sets the absolute expiration interval for all retries
func (*ExponentialRetryPolicy) SetInitialInterval ¶
func (p *ExponentialRetryPolicy) SetInitialInterval(initialInterval time.Duration)
SetInitialInterval sets the initial interval used by ExponentialRetryPolicy for the very first retry All later retries are computed using the following formula: initialInterval * math.Pow(backoffCoefficient, currentAttempt)
func (*ExponentialRetryPolicy) SetMaximumAttempts ¶
func (p *ExponentialRetryPolicy) SetMaximumAttempts(maximumAttempts int)
SetMaximumAttempts sets the maximum number of retry attempts
func (*ExponentialRetryPolicy) SetMaximumInterval ¶
func (p *ExponentialRetryPolicy) SetMaximumInterval(maximumInterval time.Duration)
SetMaximumInterval sets the maximum interval for each retry
type IsRetryable ¶
IsRetryable handler can be used to exclude certain errors during retry
type Retrier ¶
Retrier manages the state of retry operation
func NewRetrier ¶
func NewRetrier(policy RetryPolicy, clock Clock) Retrier
NewRetrier is used for creating a new instance of Retrier
type RetryPolicy ¶
type RetryPolicy interface {
ComputeNextDelay(elapsedTime time.Duration, numAttempts int) time.Duration
}
RetryPolicy is the API which needs to be implemented by various retry policy implementations
type TwoPhaseRetryPolicy ¶ added in v0.13.0
type TwoPhaseRetryPolicy struct {
// contains filtered or unexported fields
}
TwoPhaseRetryPolicy implements a policy that first use one policy to get next delay, and once expired use the second policy for the following retry. It can achieve fast retries in first phase then slowly retires in second phase.
func NewTwoPhaseRetryPolicy ¶ added in v0.13.0
func NewTwoPhaseRetryPolicy() *TwoPhaseRetryPolicy
NewTwoPhaseRetryPolicy creates TwoPhaseRetryPolicy
func (*TwoPhaseRetryPolicy) ComputeNextDelay ¶ added in v0.13.0
func (tp *TwoPhaseRetryPolicy) ComputeNextDelay(elapsedTime time.Duration, numAttempts int) time.Duration
ComputeNextDelay returns the next delay interval.