breaker

Documentation

Index

• type Interface
  • func NewService(name string, ops ...Option) Interface
• type Mood
• type Option
  • func WithAutoTune(m Mood, step, until int) Option
  • func WithBuffer(b uint) Option
  • func WithIgnoreErrors(er ...error) Option
  • func WithInitChance(c uint8) Option
  • func WithInitChanceENV(c string) Option
  • func WithPrometheus() Option
  • func WithThreshold(t uint) Option
  • func WithUpdate(u time.Duration) Option
  • func WithUpdateENV() Option

Types

type Interface

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

func NewService

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

type Mood

type Mood int

const (
	OPTIMISTIC Mood = iota
	PESSIMISTIC
)

type Option

type Option func(s *service) error

func WithAutoTune

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

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

func WithBuffer

func WithBuffer(b uint) Option

func WithIgnoreErrors

func WithIgnoreErrors(er ...error) Option

func WithInitChance

func WithInitChance(c uint8) Option

func WithInitChanceENV

func WithInitChanceENV(c string) Option

func WithPrometheus

func WithPrometheus() Option

func WithThreshold

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 WithUpdate

func WithUpdate(u time.Duration) Option

func WithUpdateENV

func WithUpdateENV() Option