Skip to content

Commit 46e72f3

Browse files
committed
docs(dashboard-agent): say where each agent button appears, and on what condition
1 parent baa3971 commit 46e72f3

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

internal-packages/dashboard-agent/GUIDEBOOK.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,39 @@ filtered page), TRQL data questions with live charts, deploy correlation
7373
Every card in every state is also browsable at `/storybook/agent-ui` (admin
7474
only), with no LLM and no data.
7575

76+
### Where the buttons are
77+
78+
Two separate mechanisms, decided differently — worth knowing before a demo.
79+
80+
**Buttons on the page itself.** Every one of them hides when the agent is off.
81+
82+
| Page | Button | Shown when |
83+
| --- | --- | --- |
84+
| Queue | Investigate | the queue is degraded: not paused, and either `running >= concurrencyLimit` with a non-empty queue, or the oldest run has waited >= 5 min |
85+
| Queue | Watch… | always |
86+
| Error group | Investigate this error | always |
87+
| Error group | Watch… | always |
88+
| Run (span panel) | Watch… | while the run is not in a final status |
89+
| Run (span panel) | Investigate | the run failed — next to the error block |
90+
| Run, waiting block | Investigate | whenever that block is on screen, which is what "still waiting" means |
91+
92+
So a queue full of runs shows only `Watch…` until something is actually
93+
executing or waiting too long — filling a queue with nothing to run it does not
94+
make the page degraded.
95+
96+
**Chips in the agent panel.** An empty chat offers up to five, chosen from the
97+
page's live signals — a different decision from the buttons above:
98+
99+
| Signal | Chip slot |
100+
| --- | --- |
101+
| `fresh_failure` | investigate |
102+
| `slow_run` | investigate |
103+
| `waiting_run` | watch |
104+
| `concurrency_saturation` | watch |
105+
106+
A backed-up queue therefore offers "tell me when the backlog drains", never
107+
"investigate" — the page's own Investigate button is the one that asks that.
108+
76109
---
77110

78111
## Prerequisites
@@ -311,13 +344,13 @@ kit error:recur # creates the error group the first time it runs
311344
**Clicks.** Errors → the group the command named → **Watch…****Customize**
312345
**if it recurs****For** `6 hours`**Watch**.
313346

314-
**Confirmation.** "Watching error c4b4a797 in case it happens again."
347+
**Confirmation.** "Watching error c4b4a797397a9c43 in case it happens again."
315348

316349
```bash
317350
kit error:recur # again, now that the watch exists
318351
```
319352

320-
**What arrives (≤5 min).** "Error c4b4a797 happened again."
353+
**What arrives (≤5 min).** "Error c4b4a797397a9c43 happened again."
321354

322355
Arm the watch **between** the two commands. A recurrence watch stamps its start
323356
when it is persisted and only counts occurrences after that moment, so an

0 commit comments

Comments
 (0)