From d715ec570f9261ddaf6efba73ddd0fead1e27b06 Mon Sep 17 00:00:00 2001 From: Christian Dupuis Date: Tue, 28 Oct 2014 13:10:16 +0100 Subject: [PATCH] Add paragraph to documentation about Hystrix /health endpoint --- docs/src/main/asciidoc/spring-cloud-netflix.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/src/main/asciidoc/spring-cloud-netflix.adoc b/docs/src/main/asciidoc/spring-cloud-netflix.adoc index 4aafc8d7..33505c40 100644 --- a/docs/src/main/asciidoc/spring-cloud-netflix.adoc +++ b/docs/src/main/asciidoc/spring-cloud-netflix.adoc @@ -277,6 +277,22 @@ annotation in a proxy that is connected to the Hystrix circuit breaker. The circuit breaker calculates when to open and close the circuit, and what to do in case of a failure. +The state of the connected circuit breakers are also exposed in the +`/health` endpoint of the calling application. + +[source,json,indent=0] +---- +{ + "hystrix": { + "openCircuitBreakers": [ + "StoreIntegration::getStoresByLocationLink" + ], + "status": "CIRCUIT_OPEN" + }, + "status": "UP" +} +---- + == Circuit Breaker: Hystrix Dashboard One of the main benefits of Hystrix is the set of metrics it gathers about each HystrixCommand. The Hystrix Dashboard displays the health of each circuit breaker in an efficient manner.