circuitbreaker

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

type Circuiter interface {
	// IsRequestAllowed returns true if the request can be processed. Clients
	// must invoke this method before processing a request.
	// Note: you must call ReportRequestStatus method to report of status of
	// the request if the request was allowed by the circuit.
	// This method is safe for concurrent use.
	IsRequestAllowed() (allowed bool)

	// ReportRequestStatus must be invoked to report the request status where
	// true mean a successful request.
	// This method will check the current failure rate and transition to Unhealthy
	// or Probing state if needed.
	// This method is safe for concurrent use.
	ReportRequestStatus(requestStatus bool)

	// Status returns the internal circuit status.
	// This method is safe for concurrent use.
	Status() *Status
}

type Config struct {
	// WindowSize defines the number of buckets in the sliding window.
	WindowSize int `yaml:"windowSize"`

	// BucketDuration defines the time duration of a bucket in the sliding window.
	BucketDuration time.Duration `yaml:"bucketDuration"`

	// RecoveryTime defines minimum amount of time duration circuit must be in the
	// Unhealthy state before transitioning to Probing state.
	RecoveryTime time.Duration `yaml:"recoveryTime"`

	// Jitter defines the additional duration on top of the recovery timeout where
	// the circuit must be in Unhealth state. A random value between 0 to Jitter
	// will be applied on top of recovery time.
	Jitter time.Duration `yaml:"jitter"`

	// MaxProbeTime defines the maximum time duration a circuit can stay in Probing state.
	MaxProbeTime time.Duration `yaml:"maxProbeTime"`

	// MinimumRequests defines the minimum number of requests a Healthy circuit
	// must be reported in the entire window before circuit checks the failure
	// rate.
	MinimumRequests int64 `yaml:"minimumRequests"`

	// FailureRatio defines the ratio at which circuit must transition to Unhealthy state.
	// The value ranges from [0.0, 1.0] where 1.0 means 100%.
	FailureRatio float64 `yaml:"failureRatio"`

	// ProbeRatios defines the list of RPS ratios to be probed during Probing state.
	// The values in the list must be sorted in the increasing order..
	// For instance when the average RPS in the window is 1000rps and a ratio of 0.1
	// means probing 100requests (0.1 * 1000).
	ProbeRatios []float64 `yaml:"probeRatios"`

	// MinimumProbeRequests defines the minimum number of requests a Probing circuit
	// must be reported in the entire window before circuit checks the failure rate
	// to either move to next probe ratio or transition to Healthy state.
	MinimumProbeRequests int64 `yaml:"minimumProbeRequests"`
}

type State int

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