ray.experimental.state.common.WorkerState#

class ray.experimental.state.common.WorkerState(worker_id: str, is_alive: bool, worker_type: typing_extensions.Literal[WORKER, DRIVER, SPILL_WORKER, RESTORE_WORKER], exit_type: Optional[typing_extensions.Literal[SYSTEM_ERROR, INTENDED_SYSTEM_EXIT, USER_ERROR, INTENDED_USER_EXIT, NODE_OUT_OF_MEMORY]], node_id: str, ip: str, pid: int, exit_detail: Optional[str], start_time_ms: int, end_time_ms: int)[source]#

Bases: ray.experimental.state.common.StateSchema

Worker State

Below columns can be used for the --filter option.

worker_id

exit_type

node_id

is_alive

ip

worker_type

pid

Below columns are available only when get API is used,

--detail is specified through CLI, or detail=True is given to Python APIs.

exit_detail

start_time_ms

end_time_ms

worker_id: str#

The id of the worker.

is_alive: bool#

Whether or not if the worker is alive.

worker_type: typing_extensions.Literal[WORKER, DRIVER, SPILL_WORKER, RESTORE_WORKER]#

The driver (Python script that calls ray.init). - SPILL_WORKER: The worker that spills objects. - RESTORE_WORKER: The worker that restores objects.

Type

  • DRIVER

exit_type: Optional[typing_extensions.Literal[SYSTEM_ERROR, INTENDED_SYSTEM_EXIT, USER_ERROR, INTENDED_USER_EXIT, NODE_OUT_OF_MEMORY]]#

The exit type of the worker if the worker is dead.

  • SYSTEM_ERROR: Worker exit due to system level failures (i.e. worker crash).

  • INTENDED_SYSTEM_EXIT: System-level exit that is intended. E.g., Workers are killed because they are idle for a long time.

  • USER_ERROR: Worker exits because of user error. E.g., execptions from the actor initialization.

  • INTENDED_USER_EXIT: Intended exit from users (e.g., users exit workers with exit code 0 or exit initated by Ray API such as ray.kill).

node_id: str#

The node id of the worker.

ip: str#

The ip address of the worker.

pid: int#

The pid of the worker.

exit_detail: Optional[str]#

The exit detail of the worker if the worker is dead.

start_time_ms: int#

The time when the worker is started and initialized.

end_time_ms: int#

The time when the worker exits. The timestamp could be delayed if the worker is dead unexpectedly.