Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 129 additions & 2 deletions docs/_docs/user-guides/cuetopia-monitoring-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ This guide provides comprehensive documentation for Cuetopia, which includes the
- [Job Color Organization](#job-color-organization)
2. [Monitor Job Details Plugin](#monitor-job-details-plugin)
3. [Job Graph Plugin](#job-graph-plugin)
4. [Filters and Search Capabilities](#filters-and-search-capabilities)
5. [Data Processing and Updates](#data-processing-and-updates)
4. [CueProgBar - Progress Bar Window](#cueprogbar---progress-bar-window)
5. [Filters and Search Capabilities](#filters-and-search-capabilities)
6. [Data Processing and Updates](#data-processing-and-updates)

---

Expand Down Expand Up @@ -347,6 +348,132 @@ Right-click on nodes provides:

---

## CueProgBar - Progress Bar Window

CueProgBar is a lightweight, standalone progress monitoring window that provides a visual representation of job frame status. It offers a minimalist interface for quick job monitoring without the overhead of the full CueGUI application.

### Launching CueProgBar

From CueGUI Job Context Menu:
- Right-click on any job in the Monitor Jobs view
- Select "Show Progress Bar" from the context menu
- A separate progress bar window opens for that job

### Interface Overview

![CueProgBar Window Interface](/assets/images/cuegui/cueprogbar/cueprogbar_window.png)

The CueProgBar window consists of three main components:

1. **Visual Progress Bar**: A horizontal bar showing frame states through color coding
2. **Status Label**: Displays current progress (e.g., "150 of 200 done, 10 running")
3. **Job Name Label**: Shows the full job name

### Frame State Color Coding

The progress bar uses distinct colors to represent different frame states:

| State | Color | Description |
|-------|-------|-------------|
| **SUCCEEDED** | Green (#37C837) | Frames that completed successfully |
| **RUNNING** | Yellow (#C8C837) | Frames currently being processed |
| **WAITING** | Light Blue (#87CFEB) | Frames ready to run when resources are available |
| **DEPEND** | Purple (#A020F0) | Frames waiting on dependencies |
| **DEAD** | Red (#FF0000) | Frames that failed and exceeded retry attempts |
| **EATEN** | Dark Red (#960000) | Frames manually marked as complete |

![CueProgBar Color Legend](/assets/images/cuegui/cueprogbar/cueprogbar_colors.png)

### Interactive Features

#### Left-Click Menu

Clicking the left mouse button on the progress bar displays a breakdown of frame states:

![CueProgBar Frame Status Menu](/assets/images/cuegui/cueprogbar/cueprogbar_left_click.png)

- Shows count for each frame state
- Color-coded icons match the progress bar colors
- Only displays states with non-zero counts

#### Right-Click Context Menu

Right-clicking the progress bar reveals job control actions:

![CueProgBar Context Menu](/assets/images/cuegui/cueprogbar/cueprogbar_right_click.png)

Available actions include:

1. **Pause/Unpause Job**:
- Toggles job execution state
- Paused jobs show "Paused" overlay on the progress bar
- Prevents new frames from starting while allowing running frames to complete

2. **Retry Dead Frames** (NEW):
- Appears only when dead frames exist
- Shows confirmation dialog with dead frame count
- Retries all frames in DEAD state
- Displays success/failure notification

![Retry Dead Frames Confirmation](/assets/images/cuegui/cueprogbar/cueprogbar_retry_confirm.png)

3. **Kill Job**:
- Terminates the job and all running frames
- Requires confirmation dialog
- Logs the action with username and timestamp

### Window Features

#### Auto-Update
- Refreshes every 5 seconds (configurable)
- Updates frame counts and progress bar in real-time
- Stops updating when job completes

#### Window Title
The window title dynamically updates to show:
- **Percentage**: "75% job_name" (for running jobs)
- **DONE**: "DONE job_name" (for completed jobs)
- **ERR**: "ERR job_name" (when dead frames exist and no frames are running)

#### Visual Indicators
- **COMPLETE** overlay: Displayed when job finishes successfully
- **Paused** overlay: Shown when job is paused
- **Job Not Found** message: Appears if job is deleted or becomes inaccessible

### Use Cases

CueProgBar is ideal for:

1. **Quick Monitoring**: Artists who want to monitor specific jobs without full CueGUI
2. **Multi-Job Tracking**: Opening multiple progress bars for different jobs simultaneously
3. **Desktop Integration**: Minimal windows that can be arranged on secondary monitors
4. **Resource Efficiency**: Lower memory and CPU usage compared to full CueGUI

### Technical Details

#### Memory Usage
- Minimal memory footprint
- No layer or frame detail caching
- Simple RPC calls for job statistics only

#### Update Mechanism
```python
# Update cycle (every 5 seconds)
1. Fetch job statistics via RPC
2. Calculate frame state totals
3. Repaint progress bar
4. Update labels and title
```

### Best Practices

1. **Multiple Windows**: Open separate progress bars for critical jobs
2. **Window Arrangement**: Stack vertically for space-efficient monitoring
3. **Close When Done**: Windows can be safely closed without affecting jobs
4. **Retry Strategy**: Use "Retry Dead Frames" before marking jobs complete

---

## Filters and Search Capabilities

### Job Search Patterns
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.