Documentation ¶
Overview ¶
Package breaker implements the circuit-breaker resiliency pattern for Go.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrBreakerOpen = errors.New("circuit breaker is open")
ErrBreakerOpen is the error returned from Run() when the function is not executed because the breaker is currently open.
Functions ¶
This section is empty.
Types ¶
type Breaker ¶
type Breaker struct {
// contains filtered or unexported fields
}
Breaker implements the circuit-breaker resiliency pattern
Example ¶
breaker := New(3, 1, 5*time.Second) for { result := breaker.Run(func() error { // communicate with some external service and // return an error if the communication failed return nil }) switch result { case nil: // success! case ErrBreakerOpen: // our function wasn't run because the breaker was open default: // some other error } }
Output:
func New ¶
New constructs a new circuit-breaker that starts closed. From closed, the breaker opens if "errorThreshold" errors are seen without an error-free period of at least "timeout". From open, the breaker half-closes after "timeout". From half-open, the breaker closes after "successThreshold" consecutive successes, or opens on a single error.
func (*Breaker) GetState ¶ added in v1.6.0
GetState returns the current State of the circuit-breaker at the moment that it is called.
func (*Breaker) Go ¶
Go will either return ErrBreakerOpen immediately if the circuit-breaker is already open, or it will run the given function in a separate goroutine. If the function is run, Go will return nil immediately, and will *not* return the return value of the function. It is safe to call Go concurrently on the same Breaker.