From 46c7334bc53f051efc76833d78a19b81d5050151 Mon Sep 17 00:00:00 2001 From: talis Date: Tue, 6 Mar 2018 14:12:32 +0200 Subject: [PATCH 1/4] Documentation for hystrix dashboard support feature (issue #1244) Signed-off-by: talis --- docs/root/operations/admin.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 71ab5345a..341cb8155 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -174,3 +174,21 @@ The fields are: .. http:get:: /runtime?format=json Outputs /runtime in JSON format. This can be used for programmatic access of runtime values. + +.. http:get:: /hystrix_event_stream + + Start streaming :ref:`event stream` to hystrix dashboard. + + The dashboard should set the stream source to this admin endpoint. + +Note on usage of Hystrix dashboard to visualize Envoy statistics: + Detalied description on Hystrix and its dashboard can be found :ref:\here`. Not all the data presented in the Hystrix dashboard is relevant in Envoy. + + * Success, Failure, Timeout, Error rate, Number of host, are shown in the dashboard. + * Hystrix's "Short circuit" is similar to Envoy's outlier detection, in that it is triggered by error responses. In Envoy the result of high error rate is the host being ejected from the load balancer pool, but it does not cause rejected requests, and therefore we set "Short circuited" to '0', and circuit breaker is set to "Forced Closed". + * "Bad request" does not exist in Envoy, and therefore is set to '0'. + * Requests rejected as a result of exceeding max number of connections or queue size (in Envoy, referred as "short circuited") are presented as "Rejected", which better suits Hystrix's terminology. + * Latency information is currently not availbale. + * Window size is set to 10sec, with 10 buckets of 1sec each. Currently, the value is not configurable. + + \ No newline at end of file From d2dc845b311cd1956d9be2486a694f792bae21f1 Mon Sep 17 00:00:00 2001 From: trabetti Date: Wed, 7 Mar 2018 13:35:59 +0200 Subject: [PATCH 2/4] fixed links and formatting Signed-off-by: trabetti --- docs/root/operations/admin.rst | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) mode change 100644 => 100755 docs/root/operations/admin.rst diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst old mode 100644 new mode 100755 index 341cb8155..92f967652 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -177,18 +177,27 @@ The fields are: .. http:get:: /hystrix_event_stream - Start streaming :ref:`event stream` to hystrix dashboard. + Start streaming + `event stream `_ + to Hystrix dashboard. Detalied description of Hystrix and its dashboard can be found + `here `_. - The dashboard should set the stream source to this admin endpoint. + The dashboard should set the stream source to this admin endpoint. -Note on usage of Hystrix dashboard to visualize Envoy statistics: - Detalied description on Hystrix and its dashboard can be found :ref:\here`. Not all the data presented in the Hystrix dashboard is relevant in Envoy. + Notes on the usage of Hystrix dashboard to visualize Envoy statistics: + Not all the data presented in the Hystrix dashboard is relevant in Envoy. - * Success, Failure, Timeout, Error rate, Number of host, are shown in the dashboard. - * Hystrix's "Short circuit" is similar to Envoy's outlier detection, in that it is triggered by error responses. In Envoy the result of high error rate is the host being ejected from the load balancer pool, but it does not cause rejected requests, and therefore we set "Short circuited" to '0', and circuit breaker is set to "Forced Closed". - * "Bad request" does not exist in Envoy, and therefore is set to '0'. - * Requests rejected as a result of exceeding max number of connections or queue size (in Envoy, referred as "short circuited") are presented as "Rejected", which better suits Hystrix's terminology. - * Latency information is currently not availbale. - * Window size is set to 10sec, with 10 buckets of 1sec each. Currently, the value is not configurable. + * Success, Failure, Timeout, Error rate, Number of host, are shown in the dashboard. + * Hystrix's "Short circuit" is similar to Envoy's outlier detection, in that it is triggered by + error responses. In Envoy the result of high error rate is the host being ejected from the load + balancer pool, but it does not cause rejected requests, and therefore we set "Short circuited" + to '0', and circuit breaker is set to "Forced Closed". + * "Bad request" does not exist in Envoy, and therefore is set to '0'. + * Requests rejected as a result of exceeding max number of connections or queue size (in Envoy, + referred as "short circuited") are presented as "Rejected", which better suits Hystrix's + terminology. + * Latency information is currently not available. + * Window size is set to 10 seconds, with 10 buckets of 1 second each. Currently, the value is + not configurable. \ No newline at end of file From 809a2e63137bceb7cb6bcfcb66a667f45edb8a2f Mon Sep 17 00:00:00 2001 From: trabetti Date: Wed, 7 Mar 2018 14:53:32 +0200 Subject: [PATCH 3/4] fix formatting Signed-off-by: trabetti --- docs/root/operations/admin.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 92f967652..1136ea54d 100755 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -177,16 +177,16 @@ The fields are: .. http:get:: /hystrix_event_stream - Start streaming - `event stream `_ - to Hystrix dashboard. Detalied description of Hystrix and its dashboard can be found - `here `_. - - The dashboard should set the stream source to this admin endpoint. + Start streaming + `event stream `_ + to Hystrix dashboard. Detalied description of Hystrix and its dashboard can be found + `here `_. + + The dashboard should set the stream source to this admin endpoint. Notes on the usage of Hystrix dashboard to visualize Envoy statistics: Not all the data presented in the Hystrix dashboard is relevant in Envoy. - + * Success, Failure, Timeout, Error rate, Number of host, are shown in the dashboard. * Hystrix's "Short circuit" is similar to Envoy's outlier detection, in that it is triggered by error responses. In Envoy the result of high error rate is the host being ejected from the load @@ -199,5 +199,5 @@ The fields are: * Latency information is currently not available. * Window size is set to 10 seconds, with 10 buckets of 1 second each. Currently, the value is not configurable. - - \ No newline at end of file + + From e7160875f72b8da2201cebae83c099f77acdeee2 Mon Sep 17 00:00:00 2001 From: trabetti Date: Wed, 7 Mar 2018 23:33:31 +0200 Subject: [PATCH 4/4] fix review comments Signed-off-by: trabetti --- docs/root/operations/admin.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 1136ea54d..dce59f855 100755 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -188,16 +188,14 @@ The fields are: Not all the data presented in the Hystrix dashboard is relevant in Envoy. * Success, Failure, Timeout, Error rate, Number of host, are shown in the dashboard. - * Hystrix's "Short circuit" is similar to Envoy's outlier detection, in that it is triggered by + * Hystrix's *Short circuit* is similar to Envoy's outlier detection, in that it is triggered by error responses. In Envoy the result of high error rate is the host being ejected from the load - balancer pool, but it does not cause rejected requests, and therefore we set "Short circuited" - to '0', and circuit breaker is set to "Forced Closed". - * "Bad request" does not exist in Envoy, and therefore is set to '0'. + balancer pool, but it does not cause rejected requests, and therefore we set *Short circuited* + to 0, and circuit breaker is set to *Forced Closed*. + * *Bad request* does not exist in Envoy, and therefore is set to 0. * Requests rejected as a result of exceeding max number of connections or queue size (in Envoy, - referred as "short circuited") are presented as "Rejected", which better suits Hystrix's + referred as *short circuited*) are presented as *Rejected*, which better suits Hystrix's terminology. * Latency information is currently not available. * Window size is set to 10 seconds, with 10 buckets of 1 second each. Currently, the value is not configurable. - -