You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: HUD.md
+65-23Lines changed: 65 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,8 @@ Use `Minigun::HUD.run_with_hud` to automatically run your task with HUD monitori
76
76
Minigun::HUD.run_with_hud(MyPipelineTask)
77
77
```
78
78
79
+
**Note**: When the pipeline finishes, the HUD stays open to display final statistics. Press `q` to exit. This allows you to review the final state, throughput metrics, and latency percentiles before closing.
80
+
79
81
### Option 3: Manual Control
80
82
81
83
For more control, manually create and manage the HUD controller:
@@ -101,36 +103,76 @@ hud_thread.join
101
103
102
104
| Key | Action |
103
105
|-----|--------|
104
-
|`q` / `Q`| Quit HUD |
105
-
|`Space`| Pause/Resume updates |
106
-
|`h` / `H` / `?`| Toggle help overlay |
107
-
|`r` / `R`| Force refresh / recalculate layout |
106
+
|`q` / `Q`| Quit HUD (works anytime, including when pipeline finished) |
107
+
|`Space`| Pause/Resume updates (disabled when finished) |
108
+
|`h` / `H` / `?`| Toggle help overlay (disabled when finished) |
109
+
|`r` / `R`| Force refresh / recalculate layout (disabled when finished) |
108
110
|`↑` / `↓`| Scroll process list |
109
-
|`d` / `D`| Toggle detailed view (future) |
111
+
|`w` / `s`| Pan flow diagram up/down |
112
+
|`a` / `d`| Pan flow diagram left/right |
110
113
|`c` / `C`| Compact view (future) |
111
114
112
115
## Display Elements
113
116
114
117
### Flow Diagram (Left Panel)
115
118
116
-
The left panel shows your pipeline stages as an animated flow diagram:
117
-
118
-
-**Stage icons**:
119
-
-`▶` Producer (generates data)
120
-
-`◆` Processor (transforms data)
121
-
-`◀` Consumer (consumes data)
122
-
-`⊞` Accumulator (batches items)
123
-
-`◇` Router (distributes to multiple stages)
124
-
-`⑂` Fork (IPC/COW process)
119
+
The left panel shows your pipeline stages as boxes with animated connections. Use `w`/`a`/`s`/`d` keys to pan the diagram for large pipelines.
125
120
126
-
-**Status indicators**:
127
-
-`⚡` Active (currently processing)
128
-
-`⏸` Idle (waiting for work)
129
-
-`⚠` Bottleneck (slowest stage)
130
-
-`✖` Error (failures detected)
131
-
-`✓` Done (completed)
121
+
```
122
+
┌─────────────────┐
123
+
│ ▶ generator ⚡ │
124
+
└──── 23.5/s ─────┘
125
+
⣿ ← flowing animation
126
+
┌─────────────────┐
127
+
│ ◆ processor ⚡ │
128
+
└──── 23.5/s ─────┘
129
+
⣿
130
+
┌─────────────────┐
131
+
│ ◀ consumer ⏸ │
132
+
└─────────────────┘
133
+
```
132
134
133
-
-**Animations**: Flowing characters indicate active data movement
135
+
**Box Components:**
136
+
-**Header Line**: Top border with stage name
137
+
-**Content**: Icon + Stage Name + Status Indicator
138
+
-**Footer**: Bottom border with throughput rate (when active)
0 commit comments