Usage Stats Data API

UsageStatsToReport

class ray._private.usage.usage_lib.UsageStatsToReport(ray_version: str, python_version: str, schema_version: str, source: str, session_id: str, git_commit: str, os: str, collect_timestamp_ms: int, session_start_timestamp_ms: int, cloud_provider: Optional[str], min_workers: Optional[int], max_workers: Optional[int], head_node_instance_type: Optional[str], worker_node_instance_types: Optional[List[str]], total_num_cpus: Optional[int], total_num_gpus: Optional[int], total_memory_gb: Optional[float], total_object_store_memory_gb: Optional[float], library_usages: Optional[List[str]], total_success: int, total_failed: int, seq_number: int)[source]

Usage stats to report

ray_version: str

The Ray version in use.

python_version: str

The Python version in use.

schema_version: str

The schema version of the report.

source: str

The source of the data (i.e. OSS).

session_id: str

A random id of the cluster session.

git_commit: str

The git commit hash of Ray (i.e. ray.__commit__).

os: str

The operating system in use.

collect_timestamp_ms: int

When the data is collected and reported.

session_start_timestamp_ms: int

When the cluster is started.

cloud_provider: Optional[str]

The cloud provider found in the cluster.yaml file (e.g., aws).

min_workers: Optional[int]

The min_workers found in the cluster.yaml file.

max_workers: Optional[int]

The max_workers found in the cluster.yaml file.

head_node_instance_type: Optional[str]

The head node instance type found in the cluster.yaml file (e.g., i3.8xlarge).

worker_node_instance_types: Optional[List[str]]

The worker node instance types found in the cluster.yaml file (e.g., i3.8xlarge).

total_num_cpus: Optional[int]

The total num of cpus in the cluster.

total_num_gpus: Optional[int]

The total num of gpus in the cluster.

total_memory_gb: Optional[float]

The total size of memory in the cluster.

total_object_store_memory_gb: Optional[float]

The total size of object store memory in the cluster.

library_usages: Optional[List[str]]

The Ray libraries that are used (e.g., rllib).

total_success: int

The total number of successful reports for the lifetime of the cluster.

total_failed: int

The total number of failed reports for the lifetime of the cluster.

seq_number: int

The sequence number of the report.