goBreaker

type Breaker struct {
	Container // contains all success, error and timeout
	sync.RWMutex
	// contains filtered or unexported fields
}

type CircuitBreaker struct {
	Breakers map[int32]*Breaker
	Mutex    sync.RWMutex
}

type Container interface {
	Fail()    // records a failure
	Succeed() // records a success
	Timeout() // records a timeout

	Failures() int64          // return the number of failures
	Successes() int64         // return the number of successes
	Timeouts() int64          // return the number of timeouts
	ConsecutiveErrors() int64 // return the consecutive errors recently
	ErrorRate() float64       // rate = (timeouts + failures) / (timeouts + failures + successes)
	Samples() int64           // (timeouts + failures + successes)
	Counts() (successes, failures, timeouts int64)

	Reset()
}

type Options struct {
	// parameters for container
	BucketTime time.Duration // the time each bucket holds
	BucketNums int           // the number of buckets the breaker have

	// parameters for breaker
	BreakerRate        float64
	BreakerMinQPS      int           // when instance > 1, if qps is over this value, the breaker trip will work
	BreakerMinSamples  int           // for RateTrip callback
	CoolingTimeout     time.Duration // fixed when create
	DetectTimeout      time.Duration // fixed when create
	HalfOpenSuccess    int
	ShouldTrip         TripFunc // trip callback, default is RateTrip func
	StateChangeHandler StateChangeHandler
	// contains filtered or unexported fields
}

type State int

type StateChangeHandler func(oldState, newState State, m Container)

type TripFunc func(Container) bool