From 9d21f856cd7c81d8a4f93c0a2398a67b12aa1b46 Mon Sep 17 00:00:00 2001 From: Anthony Atkinson Date: Sun, 4 Sep 2016 13:52:42 -0400 Subject: [PATCH] Circuit breaker markdown --- README.md | 2 +- stability/circuit_breaker.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 stability/circuit_breaker.md diff --git a/README.md b/README.md index d380ecf..dfec8f7 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ __Stability Patterns__: | Pattern | Description | |:-------:| ----------- | | TODO: [Bulkheads](stability/bulkhead.md) | Enforces a principle of failure containment (i.e. prevents cascading failures) | -| [Circuit-Breaker](stability/circuitbreaker.go) | Stops the flow of the requests when requests are likely to fail | +| [Circuit-Breaker](stability/circuit_breaker.md) | Stops the flow of the requests when requests are likely to fail | | TODO: [Deadline](stability/deadline.md) | Allows clients to stop waiting for a response once the probability of response becomes low (e.g. after waiting 10 seconds for a page refresh)| | TODO: [Fail-Fast](stability/fail_fast.md) | Checks the availability of required resources at the start of a request and fails if the requirements are not satisfied | | TODO: [Handshaking](stability/handshaking.md) | Asks a component if it can take any more load, if it can't the request is declined | diff --git a/stability/circuit_breaker.md b/stability/circuit_breaker.md new file mode 100644 index 0000000..0fb5d7c --- /dev/null +++ b/stability/circuit_breaker.md @@ -0,0 +1,7 @@ +# Circuit Breaker Pattern + +The [circuit breaker design pattern](https://en.wikipedia.org/wiki/Circuit_breaker_design_pattern) is used to detect failures and encapsulates logic of preventing a failure to reoccur constantly. + +# Implementation and Example + +An example of implementation and usage can be found in [circuitbreaker.go](circuitbreaker.go). \ No newline at end of file