README
¶
jitterbug
Tickers with random jitter
Jitterbug provides functionality similar to time.Ticker, but with a configurable random jitter.
Jitterbug has no external dependencies, has a stable API, and is production-ready.
Installation
go get -u github.com/lthibault/jitterbug/v2
Usage
Jitterbug is used by instantiating a jitterbug.Ticker with an interval and a
jitterbug.Jitter. The former specifies a baseline interval for the ticker,
to which a jitter is added by the latter.
package main
import (
"log"
"github.com/lthibault/jitterbug"
)
func main() {
t := jitterbug.New(
time.Millisecond * 300,
&jitterbug.Norm{ Stdev: time.Millisecond * 100 },
)
// jitterbug.Ticker behaves like time.Ticker
for tick := <- range t.C {
log.Println(tick)
}
}
Jitterbug is compatible with the univariate distributions from GoNum. For example:
t := jitterbug.New(
time.Millisecond * 300,
&jitterbug.Univariate{
Sampler: &distruv.Gamma{
// Tip: cast time.Duration as float64 when using gonum's distruv
Alpha: float64(time.Millisecond * 100),
Beta: float64(time.Millisecond * 200),
}
},
)
Compatible libraries
- GoNum, specifically the univariate distributions.
- Suture can use jitterbug for it's backoff durations.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Jitter ¶
type Jitter interface {
// Jitter consumes an interval from a ticker and returns the final, jittered
// duration.
Jitter(time.Duration) time.Duration
}
Jitter can compute a jitter
type Sampler ¶
type Sampler interface {
Rand() float64
}
Sampler can sample from any univariate distribution. It is used in conjunction with the Univariate type and is compatible with GoNum: https://godoc.org/gonum.org/v1/gonum/stat/distuv.
type Ticker ¶
type Ticker struct {
C <-chan time.Time
Jitter
Interval time.Duration
// contains filtered or unexported fields
}
Ticker behaves like time.Ticker
Source Files