rgarcia · October 20, 2022 07:18 · Sep 29, 2016 · Sep 28, 2016 · Sep 28, 2016 · Sep 28, 2016
diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -1,7 +1,7 @@
 # [github.com/eapache/go-resiliency/breaker](https://github.com/eapache/go-resiliency/tree/master/breaker)
 
 ```go
-func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker```
+func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker
 ```
 
 > New constructs a new circuit-breaker that starts closed.

diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -122,11 +122,15 @@ hystrix.Do("my_command", func() error {
 })
 ```
 
-> Timeout is how long to wait for command to complete, in milliseconds
-> MaxConcurrentRequests is how many commands of the same type can run at the same time
-> RequestVolumeThreshold is the minimum number of requests needed before a circuit can be tripped due to health
-> SleepWindow is how long, in milliseconds, to wait after a circuit opens before testing for recovery
-> ErrorPercentThreshold causes circuits to open once the rolling measure of errors exceeds this percent of requests
+> Timeout is how long to wait for command to complete, in milliseconds.
+
+> MaxConcurrentRequests is how many commands of the same type can run at the same time.
+
+> RequestVolumeThreshold is the minimum number of requests needed before a circuit can be tripped due to health.
+
+> SleepWindow is how long, in milliseconds, to wait after a circuit opens before testing for recovery.
+
+> ErrorPercentThreshold causes circuits to open once the rolling measure of errors exceeds this percent of requests.
 
 Other features:
 - Exposes SSE endpoint for dashboards to pull circuit status (e.g., [hystrix-dashboard](https://github.com/Netflix/Hystrix/tree/master/hystrix-dashboard)).

diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -62,7 +62,7 @@ Example: [https://github.com/sony/gobreaker/blob/master/example/http_breaker.go]
 Other features:
 - Exposes state via `func (cb *CircuitBreaker) State() State`
 
-# [https://godoc.org/github.com/streadway/handy/breaker](https://github.com/streadway/handy/tree/master/breaker)
+# [github.com/streadway/handy/breaker](https://github.com/streadway/handy/tree/master/breaker)
 
 ``` go
 func NewBreaker(failureRatio float64) Breaker
@@ -106,11 +106,11 @@ Example:
 
 ``` go
 hystrix.ConfigureCommand("my_command", hystrix.CommandConfig{
-	Timeout:               1000,
-	MaxConcurrentRequests: 100,
+	Timeout:                1000,
+	MaxConcurrentRequests:  100,
 	RequestVolumeThreshold: 20,
-	SleepWindow: 5000,
-	ErrorPercentThreshold: 25,
+	SleepWindow:            5000,
+	ErrorPercentThreshold:  25,
 })
 
 hystrix.Do("my_command", func() error {

diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -59,4 +59,80 @@ type Settings struct {
 
 Example: [https://github.com/sony/gobreaker/blob/master/example/http_breaker.go](https://github.com/sony/gobreaker/blob/master/example/http_breaker.go)
 
+Other features:
+- Exposes state via `func (cb *CircuitBreaker) State() State`
 
+# [https://godoc.org/github.com/streadway/handy/breaker](https://github.com/streadway/handy/tree/master/breaker)
+
+``` go
+func NewBreaker(failureRatio float64) Breaker
+
+type Breaker interface {
+    Allow() bool
+    Success(time.Duration)
+    Failure(time.Duration)
+}
+
+const (
+    // DefaultWindow is the default number of per-second buckets that will be
+    // considered when calculating metrics on the circuit breaker.
+    DefaultWindow = 5 * time.Second
+
+    // DefaultCooldown is the default period a circuit will remain in the open
+    // state before allowing a single sentinel request through.
+    DefaultCooldown = 1 * time.Second
+
+    // DefaultMinObservations is the default number of observations that must
+    // be made before the circuit breaker
+    DefaultMinObservations = 10
+)
+```
+
+> NewBreaker constructs a new circuit breaker, initially closed. The breaker opens after failureRatio failures per success, and only after DefaultMinObservations have been made.
+
+Other notes:
+
+> The breaker will not open if there are less then 10 (MinObservations) values to judge on (even if 100% failed)
+> If 50% (failureRatio) of all requests in the last 5 seconds (DefaultWindow) fail, the breaker will open
+> After 1 second (coolDown), the breaker will allow one request again, to check availability
+
+Other features:
+- Exposes manual recording of `Success`/`Failure` (other ones expose wrappers like `Run(func(error))`)
+- Exposes functions that return `http.Handler` and `http.RoundTripper` for circuit breaking in middleware and clients.
+
+# [github.com/afex/hystrix-go/hystrix](github.com/afex/hystrix-go/hystrix)
+
+Example:
+
+``` go
+hystrix.ConfigureCommand("my_command", hystrix.CommandConfig{
+	Timeout:               1000,
+	MaxConcurrentRequests: 100,
+	RequestVolumeThreshold: 20,
+	SleepWindow: 5000,
+	ErrorPercentThreshold: 25,
+})
+
+hystrix.Do("my_command", func() error {
+	// talk to other services
+	return nil
+}, func(err error) error {
+	// fallback for when services are down
+	return nil
+})
+```
+
+> Timeout is how long to wait for command to complete, in milliseconds
+> MaxConcurrentRequests is how many commands of the same type can run at the same time
+> RequestVolumeThreshold is the minimum number of requests needed before a circuit can be tripped due to health
+> SleepWindow is how long, in milliseconds, to wait after a circuit opens before testing for recovery
+> ErrorPercentThreshold causes circuits to open once the rolling measure of errors exceeds this percent of requests
+
+Other features:
+- Exposes SSE endpoint for dashboards to pull circuit status (e.g., [hystrix-dashboard](https://github.com/Netflix/Hystrix/tree/master/hystrix-dashboard)).
+- Could use [hystrixjs](https://bitbucket.org/igor_sechyn/hystrixjs) in JS clients to have same settings and expose the same SSE endpoint.
+- Max concurrent requests is a nice sanity check
+
+# [github.com/go-kit/kit/circuitbreaker](https://github.com/go-kit/kit)
+
+Wrapper around either sony/gobreaker, handy/breaker, and hystrix-go (user's choice).
diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -4,10 +4,10 @@
 func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker```
 ```
 
-*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.*
+> 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.
 
 Usage:
 
@@ -47,15 +47,15 @@ type Settings struct {
 
 > 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.
+> 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.
+> 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.
+> 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 ReadyToTrip returns true when the number of consecutive failures is more than 5.
+> 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 ReadyToTrip returns true when the number of consecutive failures is more than 5.
 
-OnStateChange is called whenever the state of the CircuitBreaker changes.*
+> OnStateChange is called whenever the state of the CircuitBreaker changes.*
 
 Example: [https://github.com/sony/gobreaker/blob/master/example/http_breaker.go](https://github.com/sony/gobreaker/blob/master/example/http_breaker.go)
 

diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -45,7 +45,7 @@ type Settings struct {
 }
 ```
 
-*Name is the name of the CircuitBreaker.
+> 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.
 

diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -42,7 +42,8 @@ type Settings struct {
     Timeout       time.Duration
     ReadyToTrip   func(counts Counts) bool
     OnStateChange func(name string, from State, to State)
-}```
+}
+```
 
 *Name is the name of the CircuitBreaker.
 
@@ -59,4 +60,3 @@ OnStateChange is called whenever the state of the CircuitBreaker changes.*
 Example: [https://github.com/sony/gobreaker/blob/master/example/http_breaker.go](https://github.com/sony/gobreaker/blob/master/example/http_breaker.go)
 
 
-
diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -1,4 +1,4 @@
-# [github.com/eapache/go-resiliency/breaker](github.com/eapache/go-resiliency/breaker)
+# [github.com/eapache/go-resiliency/breaker](https://github.com/eapache/go-resiliency/tree/master/breaker)
 
 ```go
 func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker```
@@ -11,7 +11,7 @@ From half-open, the breaker closes after "successThreshold" consecutive successe
 
 Usage:
 
-```golang
+```go
 for {
     result := breaker.Run(func() error {
         // communicate with some external service and
@@ -30,3 +30,33 @@ for {
 }
 ```
 
+# [https://github.com/sony/gobreaker](https://github.com/sony/gobreaker)
+
+```go
+func NewCircuitBreaker(st Settings) *CircuitBreaker
+
+type Settings struct {
+    Name          string
+    MaxRequests   uint32
+    Interval      time.Duration
+    Timeout       time.Duration
+    ReadyToTrip   func(counts Counts) bool
+    OnStateChange func(name string, from State, to State)
+}```
+
+*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 ReadyToTrip returns true when the number of consecutive failures is more than 5.
+
+OnStateChange is called whenever the state of the CircuitBreaker changes.*
+
+Example: [https://github.com/sony/gobreaker/blob/master/example/http_breaker.go](https://github.com/sony/gobreaker/blob/master/example/http_breaker.go)
+
+
+
diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -1,4 +1,4 @@
-# github.com/eapache/go-resiliency/breaker
+# [github.com/eapache/go-resiliency/breaker](github.com/eapache/go-resiliency/breaker)
 
 ```go
 func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker```

diff --git a/circuit_breakers.md b/circuit_breakers.md
@@ -0,0 +1,32 @@
+# github.com/eapache/go-resiliency/breaker
+
+```go
+func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker```
+```
+
+*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.*
+
+Usage:
+
+```golang
+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
+    }
+}
+```
+
No results found