breaker

package

v2.8.18 Latest Latest Go to latest Published: Aug 17, 2022 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Interface interface {
	Allow() bool
	Event() chan<- error
}

func NewService(name string, ops ...Option) Interface

type Mood int

const (
	NOOP Mood = iota
	OPTIMISTIC
	PESSIMISTIC
)

type Option func(s *service) error

func WithAutoTune(m Mood, step, until int) Option

WithAutoTune will help reduce / increase the odds in the absence of an event

func WithAutoTuneENV() Option

WithAutoTuneENV will help reduce / increase the odds in the absence of an event

func WithBuffer(b uint) Option

func WithBufferENV() Option

func WithIgnoreErrors(er ...error) Option

func WithInitChance(c uint8) Option

func WithInitChanceENV() Option

func WithMaxStep(c uint8) Option

func WithMinStep(c uint8) Option

func WithPrometheus() Option

func WithThreshold(t uint) Option

WithThreshold is the allowed percentage to pass for example if the value is set to 7 any request with the chance of 93% or more will pass

func WithThresholdENV() Option

func WithUpdate(u time.Duration) Option

func WithUpdateENV() Option