ray.serve.schema.ReplicaDetails#

pydantic model ray.serve.schema.ReplicaDetails[source]#

Detailed info about a single deployment replica.

Show JSON schema

{
   "title": "ReplicaDetails",
   "description": "Detailed info about a single deployment replica.",
   "type": "object",
   "properties": {
      "node_id": {
         "title": "Node Id",
         "description": "ID of the node that the actor is running on.",
         "type": "string"
      },
      "node_ip": {
         "title": "Node Ip",
         "description": "IP address of the node that the actor is running on.",
         "type": "string"
      },
      "actor_id": {
         "title": "Actor Id",
         "description": "Actor ID.",
         "type": "string"
      },
      "actor_name": {
         "title": "Actor Name",
         "description": "Actor name.",
         "type": "string"
      },
      "worker_id": {
         "title": "Worker Id",
         "description": "Worker ID.",
         "type": "string"
      },
      "log_file_path": {
         "title": "Log File Path",
         "description": "The relative path to the Serve actor's log file from the ray logs directory.",
         "type": "string"
      },
      "replica_id": {
         "title": "Replica Id",
         "description": "Unique ID for the replica.",
         "type": "string"
      },
      "state": {
         "description": "Current state of the replica.",
         "allOf": [
            {
               "$ref": "#/definitions/ReplicaState"
            }
         ]
      },
      "pid": {
         "title": "Pid",
         "description": "PID of the replica actor process.",
         "type": "integer"
      },
      "start_time_s": {
         "title": "Start Time S",
         "description": "The time at which the replica actor was started. If the controller dies, this is the time at which the controller recovers and retrieves replica state from the running replica actor.",
         "type": "number"
      }
   },
   "required": [
      "replica_id",
      "state",
      "start_time_s"
   ],
   "definitions": {
      "ReplicaState": {
         "title": "ReplicaState",
         "description": "An enumeration.",
         "enum": [
            "STARTING",
            "UPDATING",
            "RECOVERING",
            "RUNNING",
            "STOPPING",
            "PENDING_MIGRATION"
         ],
         "type": "string"
      }
   }
}

Fields:

pid (int | None)
replica_id (str)
start_time_s (float)
state (ray.serve._private.common.ReplicaState)

field pid: int | None = None#: PID of the replica actor process.

field replica_id: str [Required]#: Unique ID for the replica.

field start_time_s: float [Required]#: The time at which the replica actor was started. If the controller dies, this is the time at which the controller recovers and retrieves replica state from the running replica actor.

field state: ReplicaState [Required]#: Current state of the replica.