From 18218cf35e72a369168f6accb079b6238dec8a67 Mon Sep 17 00:00:00 2001 From: trabetti <31645500+trabetti@users.noreply.github.com> Date: Tue, 30 Jan 2018 11:01:28 +0200 Subject: [PATCH 1/3] Update admin.rst --- docs/root/operations/admin.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 4b967c5fe..80f59005f 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -174,3 +174,19 @@ 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's url. + +Important 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 rejecetd requests, and therefore we set "Short circuited" to '0', and circuit breaker is set to "Forced Closed". + * "Bad request" do not exist in Envoy, and therefore it 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. + + From b7a6ba4ccb348a06ea8bb481654adf2da923edfc Mon Sep 17 00:00:00 2001 From: trabetti <31645500+trabetti@users.noreply.github.com> Date: Tue, 30 Jan 2018 13:34:23 +0200 Subject: [PATCH 2/3] fix typos pointed out by Vadim --- docs/root/operations/admin.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 80f59005f..29bdffc68 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -183,8 +183,8 @@ Important 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 rejecetd requests, and therefore we set "Short circuited" to '0', and circuit breaker is set to "Forced Closed". - * "Bad request" do not exist in Envoy, and therefore it set to '0'. + * 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 it 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. From fe696aa576262b81af33125184163ce5e776ea0f Mon Sep 17 00:00:00 2001 From: trabetti <31645500+trabetti@users.noreply.github.com> Date: Thu, 22 Feb 2018 11:05:51 +0200 Subject: [PATCH 3/3] update dashboard link + small fixes --- docs/root/operations/admin.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 29bdffc68..d03b899a1 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -177,14 +177,16 @@ The fields are: .. http:get:: /hystrix_event_stream - Start streaming :ref:`event stream` to hystrix dashboard. The dashboard should set the stream source to this admin's url. + Start streaming :ref:`event stream` to hystrix dashboard. + + The dashboard should set the stream source to this admin endpoint. -Important 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. +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 it set to '0'. + * "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.