Ray State CLI

State

This section contains commands to access the live state of Ray resources (actor, task, object, etc.).

Note

APIs are alpha. This feature requires a full installation of Ray using pip install "ray[default]". This feature also requires the dashboard component to be available. The dashboard component needs to be included when starting the ray cluster, which is the default behavior for ray start and ray.init(). For more in-depth debugging, you could check the dashboard log at <RAY_LOG_DIR>/dashboard.log, which is usually /tmp/ray/session_latest/logs/dashboard.log.

State CLI allows users to access the state of various resources (e.g., actor, task, object).

Log

This section contains commands to access logs from Ray clusters.

Note

APIs are alpha. This feature requires a full installation of Ray using pip install "ray[default]".

Log CLI allows users to access the log from the cluster. Note that only the logs from alive nodes are available through this API.