[Serve] [Doc] Add small dashboard section under Serve Monitoring (#14328)

This commit is contained in:
architkulkarni 2021-03-08 18:41:42 -08:00 committed by GitHub
parent 3616424f10
commit 505d2b6abe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -208,6 +208,21 @@ Please refer to the Kubernetes documentation for more information.
Monitoring
==========
Ray Dashboard
-------------
A high-level way to monitor your Ray Serve deployment (or any Ray application) is via the Ray Dashboard.
See the `Ray Dashboard documentation <../ray-dashboard.html>`__ for a detailed overview, including instructions on how to view the dashboard.
Below is an example of what the Ray Dashboard might look like for a Serve deployment:
.. image:: https://raw.githubusercontent.com/ray-project/Images/master/docs/dashboard/serve-dashboard.png
:align: center
Here you can see the Serve controller actor, an HTTP proxy actor, and all of the replicas for each Serve backend in the deployment.
To learn about the function of the controller and proxy actors, see the `Serve Architecture page <architecture.html>`__.
In this example pictured above, we have a single-node cluster with a backend class called Counter with ``num_replicas=2`` in its :class:`~ray.serve.BackendConfig`.
Logging
-------