状态 API#

注意

这些 API 处于 Alpha 阶段。此功能需要使用 pip install "ray[default]" 进行完整安装。

有关带示例的概述,请参阅 监控 Ray 状态

有关 CLI 参考,请参阅 Ray 状态 CLI 参考Ray 日志 CLI 参考

状态 Python SDK#

状态 API 也作为函数导出。

摘要 API#

ray.util.state.summarize_actors

汇总集群中的 Actor。

ray.util.state.summarize_objects

汇总集群中的对象。

ray.util.state.summarize_tasks

汇总集群中的任务。

列表 API#

ray.util.state.list_actors

列出集群中的 Actor。

ray.util.state.list_placement_groups

列出集群中的放置组。

ray.util.state.list_nodes

列出集群中的节点。

ray.util.state.list_jobs

列出通过 Ray 作业提交 提交到集群的作业。

ray.util.state.list_workers

列出集群中的工作进程。

ray.util.state.list_tasks

列出集群中的任务。

ray.util.state.list_objects

列出集群中的对象。

ray.util.state.list_runtime_envs

列出集群中的运行时环境。

获取 API#

ray.util.state.get_actor

按 ID 获取 Actor。

ray.util.state.get_placement_group

按 ID 获取放置组。

ray.util.state.get_node

按 ID 获取节点。

ray.util.state.get_worker

按 ID 获取工作进程。

ray.util.state.get_task

按 ID 获取任务的尝试次数。

ray.util.state.get_objects

按 ID 获取对象。

日志 API#

ray.util.state.list_logs

列出可用的日志文件。

ray.util.state.get_log

根据文件名或某些实体 ID(进程 ID、Actor ID、任务 ID)检索日志文件。

状态 API 模式#

ray.util.state.common.ActorState

Actor 状态

ray.util.state.common.TaskState

任务状态

ray.util.state.common.NodeState

节点状态

ray.util.state.common.PlacementGroupState

PlacementGroup 状态

ray.util.state.common.WorkerState

Worker 状态

ray.util.state.common.ObjectState

对象状态

ray.util.state.common.RuntimeEnvState

运行时环境状态

ray.util.state.common.JobState

通过 Ray Job API 或驱动程序提交的作业状态

ray.util.state.common.StateSummary

ray.util.state.common.TaskSummaries

ray.util.state.common.TaskSummaryPerFuncOrClassName

ray.util.state.common.ActorSummaries

ray.util.state.common.ActorSummaryPerClass

ray.util.state.common.ObjectSummaries

ray.util.state.common.ObjectSummaryPerKey

状态 API 异常#

ray.util.state.exception.RayStateApiException