circuitbreaker

Documentation

Index

• func CircuitHealthCheck() (map[string]string, error)
• func Open(service, endpoint string) bool
• func Result(service, endpoint string, err error)
• type Circuit
• type DefaultCircuit
  • func NewDefaultCircuit(opts Options) *DefaultCircuit
  • func (r *DefaultCircuit) Open() bool
  • func (r *DefaultCircuit) Result(err error)
• type Options

Functions

func CircuitHealthCheck

func CircuitHealthCheck() (map[string]string, error)

CircuitHealthCheck will report if a circuit is open

func Open

func Open(service, endpoint string) bool

Open is a helper function to call open on the correct default circuit

func Result

func Result(service, endpoint string, err error)

Result is a helper function to call Result on the correct default circuit

Types

type Circuit

type Circuit interface {
	Open() bool
	Result(err error)
}

Circuit keeps track of whether a connection is open or closed

type DefaultCircuit

type DefaultCircuit struct {
	// contains filtered or unexported fields
}

func NewDefaultCircuit

func NewDefaultCircuit(opts Options) *DefaultCircuit

func (*DefaultCircuit) Open

func (r *DefaultCircuit) Open() bool

func (*DefaultCircuit) Result

func (r *DefaultCircuit) Result(err error)

type Options

type Options struct {
	Disabled bool `json:"disabled,omitempty"`

	// Rate threshold config
	Threshold  float64 `json:"threshold,omitempty"`
	MinSamples int64   `json:"minSamples,omitempty"`

	// Backoff config
	Multiplier          float64 `json:"multiplier,omitempty"`
	RandomizationFactor float64 `json:"randomizationFactor,omitempty"`
	InitialIntervalMs   int64   `json:"initialIntervalMs,omitempty"`
	MaxIntervalMs       int64   `json:"maxIntervalMs,omitempty"`
	MaxElapsedTimeMs    int64   `json:"maxElapsedTimeMs,omitempty"`
}