From 0f573dfe9494a43b17b3e5471fd1db2450404718 Mon Sep 17 00:00:00 2001 From: Spencer Gibb Date: Wed, 5 Nov 2014 18:18:04 -0700 Subject: [PATCH] Added notes about how to configure @HystrixCommand and where to go to find out more information. fixes gh-58 --- docs/src/main/asciidoc/spring-cloud-netflix.adoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/src/main/asciidoc/spring-cloud-netflix.adoc b/docs/src/main/asciidoc/spring-cloud-netflix.adoc index 66e61251..64f155e6 100644 --- a/docs/src/main/asciidoc/spring-cloud-netflix.adoc +++ b/docs/src/main/asciidoc/spring-cloud-netflix.adoc @@ -305,11 +305,18 @@ public class StoreIntegration { ---- The `@HystrixCommand` is provided by a Netflix contrib library called -"javanica". Spring Cloud automatically wraps Spring beans with that +https://github.com/Netflix/Hystrix/tree/master/hystrix-contrib/hystrix-javanica["javanica"]. +Spring Cloud automatically wraps Spring beans with that 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. +To configure the `@HystrixCommand` you can use the `commandProperties` +attribute with a list of `@HystrixProperty` annotations. See +https://github.com/Netflix/Hystrix/tree/master/hystrix-contrib/hystrix-javanica#configuration[here] +for more details. See the https://github.com/Netflix/Hystrix/wiki/Configuration[Hystrix wiki] +for details on the properties available. + The state of the connected circuit breakers are also exposed in the `/health` endpoint of the calling application.