circuitbreaker

Documentation

Index

• type CircuitBreaker
  • func NewCircuitBreaker(ctx context.Context, name string) *CircuitBreaker
  • func (c *CircuitBreaker) Allow() (func(error), error)

Types

type CircuitBreaker

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

func NewCircuitBreaker

func NewCircuitBreaker(ctx context.Context, name string) *CircuitBreaker

newCircuitBreaker creates TwoStepCircuitBreaker with suitable settings.

Name is the name of the CircuitBreaker.

MaxRequests is the maximum number of requests allowed to pass through when the CircuitBreaker is half-open. If MaxRequests is 0, the CircuitBreaker allows only 1 request.

Interval is the cyclic period of the closed state for the CircuitBreaker to clear the internal Counts. If Interval is 0, the CircuitBreaker doesn't clear internal Counts during the closed state.

Timeout is the period of the open state, after which the state of the CircuitBreaker becomes half-open. If Timeout is 0, the timeout value of the CircuitBreaker is set to 60 seconds.

ReadyToTrip is called with a copy of Counts whenever a request fails in the closed state. If ReadyToTrip returns true, the CircuitBreaker will be placed into the open state. If ReadyToTrip is nil, default ReadyToTrip is used.

Default settings: MaxRequests: 3 Interval: 5 * time.Second Timeout: 10 * time.Second ReadyToTrip: DefaultReadyToTrip

func (*CircuitBreaker) Allow

func (c *CircuitBreaker) Allow() (func(error), error)