package monitoring
Get desktop application:
View/edit binary Protocol Buffers messages
Service for querying historical monitoring data
Get aggregated statistics over a time range
message
monitoring.proto:422GetFarmStatistics
optional time_range = 1
int32 interval_minutes = 2
Aggregation interval
repeated string shows = 3
Filter by shows
message
monitoring.proto:428repeated statistics = 1
rpc GetFrameHistory (, )
monitoring.proto:261Get historical frame events for a job
message
monitoring.proto:335GetFrameHistory
string job_id = 1
string job_name = 2
repeated string layer_names = 3
repeated job.FrameState states = 4
optional time_range = 5
int32 page = 6
Pagination
int32 page_size = 7
message
monitoring.proto:347repeated frames = 1
optional pagination = 2
rpc GetHostHistory (, )
monitoring.proto:267Get historical host events
message
monitoring.proto:404GetHostHistory
repeated string host_names = 1
repeated string facilities = 2
repeated string allocations = 3
repeated host.HardwareState states = 4
optional time_range = 5
int32 page = 6
Pagination
int32 page_size = 7
message
monitoring.proto:416repeated events = 1
optional pagination = 2
rpc GetJobHistory (, )
monitoring.proto:258Get historical job events
message
monitoring.proto:293GetJobHistory
repeated string shows = 1
Filter criteria
repeated string users = 2
repeated string shots = 3
repeated string job_name_regex = 4
repeated job.JobState states = 5
optional time_range = 6
int32 page = 7
Pagination
int32 page_size = 8
int32 max_results = 9
message
monitoring.proto:308repeated jobs = 1
optional pagination = 2
rpc GetLayerHistory (, )
monitoring.proto:264Get historical layer events for a job
message
monitoring.proto:371GetLayerHistory
string job_id = 1
string job_name = 2
optional time_range = 3
int32 page = 4
Pagination
int32 page_size = 5
message
monitoring.proto:381repeated layers = 1
optional pagination = 2
Get memory usage history for a layer
message
monitoring.proto:433GetLayerMemoryHistory
string layer_name = 1
repeated string shows = 2
optional time_range = 3
int32 max_results = 4
message
monitoring.proto:440repeated records = 1
message
monitoring.proto:61Common header for all monitoring events
Used in: , , , , ,
string event_id = 1
Unique event ID (UUID)
EventType event_type = 2
Event type
int64 timestamp = 3
Timestamp when event occurred (Unix epoch milliseconds)
string source_cuebot = 4
Source cuebot instance that generated the event
string correlation_id = 5
Optional correlation ID for tracing related events
Types of lifecycle events
Used in:
EVENT_TYPE_UNKNOWN = 0
JOB_CREATED = 1
Job events
JOB_STARTED = 2
JOB_PAUSED = 3
JOB_RESUMED = 4
JOB_FINISHED = 5
JOB_KILLED = 6
LAYER_CREATED = 10
Layer events
LAYER_STARTED = 11
LAYER_COMPLETED = 12
FRAME_DISPATCHED = 20
Frame events
FRAME_STARTED = 21
FRAME_COMPLETED = 22
FRAME_FAILED = 23
FRAME_RETRIED = 24
FRAME_KILLED = 25
FRAME_EATEN = 26
FRAME_CHECKPOINT = 27
HOST_BOOT = 31
Host events
HOST_STATE_CHANGED = 32
HOST_LOCKED = 33
HOST_UNLOCKED = 34
PROC_BOOKED = 40
Proc events
PROC_UNBOOKED = 41
PROC_REDIRECTED = 42
message
monitoring.proto:203Periodic snapshot of farm-wide statistics
Used in:
optional header = 1
int64 snapshot_time = 2
Snapshot time
int32 total_jobs = 3
Job statistics
int32 pending_jobs = 4
int32 finished_jobs = 5
int64 total_frames = 6
Frame statistics
int64 waiting_frames = 7
int64 running_frames = 8
int64 succeeded_frames = 9
int64 dead_frames = 10
int64 eaten_frames = 11
int64 depend_frames = 12
int32 total_hosts = 13
Host statistics
int32 up_hosts = 14
int32 down_hosts = 15
int32 repair_hosts = 16
int32 nimby_locked_hosts = 17
float total_cores = 18
Resource utilization
float running_cores = 19
float idle_cores = 20
float total_gpus = 21
float running_gpus = 22
float idle_gpus = 23
int64 total_memory = 24
int64 used_memory = 25
repeated show_stats = 26
Per-show breakdown
message
monitoring.proto:110optional header = 1
optional frame = 2
Embedded frame data
string layer_id = 3
Context fields (not in Frame message)
string job_id = 4
string job_name = 5
string show = 6
job.FrameState previous_state = 7
Event-specific fields
int32 exit_signal = 8
int32 run_time = 9
int32 num_cores = 10
Resource allocation (not in Frame message)
int32 num_gpus = 11
string host_name = 12
Host information
string resource_id = 13
string reason = 14
Kill reason if applicable
string killed_by = 15
message
monitoring.proto:352Used in:
string id = 1
string name = 2
string layer_name = 3
string job_name = 4
string show = 5
int32 frame_number = 6
job.FrameState final_state = 7
int32 exit_status = 8
int32 retry_count = 9
int32 start_time = 10
int32 stop_time = 11
int64 max_rss = 12
string last_host = 13
int32 total_core_time = 14
int32 total_gpu_time = 15
message
monitoring.proto:313Used in:
string id = 1
string name = 2
string show = 3
string shot = 4
string user = 5
string facility = 6
job.JobState final_state = 7
int32 start_time = 8
int32 stop_time = 9
int32 priority = 10
int32 total_frames = 11
Final statistics
int32 succeeded_frames = 12
int32 failed_frames = 13
int64 total_core_seconds = 14
int64 total_gpu_seconds = 15
int64 max_rss = 16
message
monitoring.proto:386Used in:
string id = 1
string name = 2
string job_name = 3
string show = 4
job.LayerType type = 5
repeated string tags = 6
repeated string services = 7
int32 total_frames = 8
int32 succeeded_frames = 9
int32 failed_frames = 10
int64 total_core_seconds = 11
int64 total_gpu_seconds = 12
int64 max_rss = 13
int64 avg_frame_seconds = 14
message
monitoring.proto:142Used in:
optional header = 1
optional host = 2
Embedded host data
string facility = 3
Context fields (not in Host message)
host.HardwareState previous_state = 4
Event-specific fields
host.LockState previous_lock_state = 5
bool nimby_locked = 6
string reason = 7
Reason for state change if applicable
message
monitoring.proto:80optional header = 1
optional job = 2
Embedded job data (uses composition instead of duplicating fields)
job.JobState previous_state = 3
Event-specific fields
string reason = 4
Kill/finish reason if applicable
string killed_by = 5
message
monitoring.proto:96optional header = 1
optional layer = 2
Embedded layer data
string job_id = 3
Context fields (not in Layer message)
string job_name = 4
string show = 5
message
monitoring.proto:444Used in:
string job_name = 1
string layer_name = 2
string show = 3
int32 timestamp = 4
int64 max_rss = 5
int64 reserved_memory = 6
int32 frame_count = 7
int64 avg_frame_memory = 8
int64 p95_frame_memory = 9
message
monitoring.proto:285Pagination for results
Used in: , , ,
int32 page = 1
int32 page_size = 2
int32 total_pages = 3
int64 total_records = 4
message
monitoring.proto:162optional header = 1
string proc_id = 2
Proc identification
string proc_name = 3
string host_id = 4
string host_name = 5
string job_id = 6
Assignment information
string job_name = 7
string layer_id = 8
string layer_name = 9
string frame_id = 10
string frame_name = 11
string show = 12
string group_name = 13
float reserved_cores = 14
Resource reservation
float reserved_gpus = 15
int64 reserved_memory = 16
int64 reserved_gpu_memory = 17
int32 dispatch_time = 18
Booking information
int32 booked_time = 19
bool is_local_dispatch = 20
bool is_unbooked = 21
string redirect_target = 22
Redirect target if applicable
repeated string services = 23
Services
message
monitoring.proto:244Used in:
string show = 1
int32 pending_jobs = 2
int64 running_frames = 3
int64 waiting_frames = 4
float reserved_cores = 5
float reserved_gpus = 6
message
monitoring.proto:279Time range for historical queries
Used in: , , , , ,
int64 start_time = 1
Unix epoch milliseconds
int64 end_time = 2
Unix epoch milliseconds