go-delay

Utility functions for calculating backoff and jitter.

Installation

go get github.com/cholland1989/go-delay

This library supports version 1.18 and later of Go.

Usage

import "github.com/cholland1989/go-delay/pkg/delay"
import "github.com/cholland1989/go-delay/pkg/retry"
import "github.com/cholland1989/go-delay/pkg/sleep"

Package delay provides utility functions for calculating backoff and jitter.

delay.LinearBackoff calculates the specified duration with linear backoff, according to the formula duration * multiplier * (attempt + 1). For example, delay.LinearBackoff(time.Second, 2.0, 3) will return a time.Duration representing 8 seconds.

delay.ExponentialBackoff calculates the specified duration with exponential backoff, according to the formula duration * pow(multiplier, attempt + 1). For example, delay.ExponentialBackoff(time.Second, 2.0, 3) will return a time.Duration representing 16 seconds.

delay.RateLimit calculates the minimum duration per action for the specified actions per time period, according to the formula period / actions. For example, delay.RateLimit(2, time.Second) will return a time.Duration representing 0.5 seconds.

delay.RandomJitter calculates the specified duration plus or minus random jitter. For example, delay.RandomJitter(time.Second, 0.5) will return a time.Duration between 0.5 seconds and 1.5 seconds.

Package retry and sleep provide wrapper functions to simplify the most common use cases.

See the documentation for more details.

License

Released under the MIT License.