Skip to content

Update admin.rst #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trabetti wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update admin.rst #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18218cf
Update admin.rst
trabetti Jan 30, 2018
b7a6ba4
fix typos pointed out by Vadim
trabetti Jan 30, 2018
fe696aa
update dashboard link + small fixes
trabetti Feb 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/root/operations/admin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events>` 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<https://github.com/Netflix-Skunkworks/hystrix-dashboard>`. 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.