Repository navigation
docs: update Agent Relay SIEM alert messages for v0.15.0 - #31836
coder[bot] wants to merge 1 commit into
Conversation
c1b3786 to
8447360
Compare
8447360 to
7680b1f
Compare
| | `build_status` | The latest build's status when Agent Relay rebuilds a workspace or the reaper evaluates it | | ||
| | `deadline` | Claude Code: when Anthropic stops waiting for a runner. Logged when the deadline passes before dispatch. | | ||
| | `status` | Reaper: the runner status the workspace reported, such as `working`, `done 1`, `failed <reason>`, or `orphaned` | | ||
| | `agent_lifecycle` | The workspace agent's lifecycle state, such as `starting` or `ready`, on `workspace built, runner handoff` and reaper records. Empty when no agent is connected. `starting` means startup scripts are still running, and `start_error` or `start_timeout` means they failed. | |
There was a problem hiding this comment.
The on workspace built, runner handoff and reaper records clause names where the field comes from, not anything the reader types or receives to use it, and it is coupled to two msg strings the page itself warns are unstable between releases (see "Match rules", line 208). (Reader Advocate)
The reader scopes records by msg and logger_names (lines 206-211), not by this field, so the location clause is a drift vector and says nothing about which records to match. Reframe it around what the reader does: note that the field appears only on workspace build records and on reaper records, and pair it with the existing parse note to match those records by logger_names (reaper) and the build msg rather than by this field. Keep the value examples and the empty-when-no-agent note, which the reader does need.
There was a problem hiding this comment.
Leaving this as is.
A reader building a search needs to know which records carry agent_lifecycle, and the page's Match rules section tells them to match on msg.
The alerts table on this page already depends on msg strings, and the page tells readers to recheck them after each upgrade.
Generated by Coder Agents.
Documentation CheckRelated open PRs
Findings for agents- id: audience-siem-agent-lifecycle-where
persona: audience
class: suggestion
blocking: false
file: docs/agent-relay/monitoring/siem.md
line: 91
quote: "The workspace agent's lifecycle state, such as `starting` or `ready`, on `workspace built, runner handoff` and reaper records. Empty when no agent is connected."
evidence:
- docs/agent-relay/monitoring/siem.md:206-211 (match on `msg` and `logger_names`, not this field)
rule: null
problem: The location clause names provenance rather than what the reader types or receives, and is coupled to two `msg` strings the page warns are unstable between releases.
fix: Reframe around what the reader does; keep the value examples and the empty-when-no-agent note.
verified: trueAutomated review via Coder Agents. Reply to a finding's thread with the reason if the finding is wrong. |
Agent Relay v0.15.0 replaced the fixed 300-second Claude Code spawn budget with a per-pool `dispatch_deadline` ([agent-relay#147](coder/agent-relay#147)). - `claude-code.md`: rewrite **Build budget** (default `5m`, `10s` to `15m`, whole seconds, can't be turned off, sent to Anthropic as the hint TTL, needs v0.15.0) and add the field to both pool examples. - `configuration.md`: add `dispatch_deadline` to the Claude Code pool fields. - `troubleshooting.md`, `monitoring/siem.md`: drop the fixed 300-second wording. Verification notes: - Checked against `internal/services/serviceclaudecoderunners` (`parseDispatchDeadline`, `poller.go` constants) at v0.15.0 (`9b96578`). - The old text said Agent Relay returns a missed-budget session as **retryable**. In v0.15.0, Claude requests use `TerminalOnDeadline` ([agent-relay#138](coder/agent-relay#138)), so a failure at or after the deadline is nacked non-retryable. The page now says Agent Relay "reports the failure" and doesn't claim either way. Stack 1/5. Review and merge in order: - #31834 - #31835 - #31836 - #31837 - #31838 Refs DOCS-1171 > Generated by Coder Agents. --------- Co-authored-by: coder[bot] <137810501+coder[bot]@users.noreply.github.com> Co-authored-by: Nick Vigilante <nick.vigilante@coder.com>
Match the log messages that Agent Relay v0.15.0 writes, and document the agent_lifecycle field from coder/agent-relay#154.
7680b1f to
495be2c
Compare
|
Closing and reopening under a human author, as required for this repository. |
Updates
monitoring/siem.mdto the log messages Agent Relay v0.15.0 writes.msgmsgworkspace ready, runner handoffworkspace built, runner handoff(agent-relay#154)workspace build passed the session deadline, reporting retryable and deletingworkspace build passed the session deadline, reporting failure(also listsworkspace build succeeded after the session deadline)workspace build failed, reporting retryable and deletingworkspace build faileddelete workspace failed, leaving for reconciliationdelete workspace failed, leaving it for the reaperThe PR also adds the
agent_lifecyclefield, which appears on the handoff record and on reaper records.Verification notes:
msginsiem.mdwas checked by greppinginternal/at9b96578and still matches.leaving for reconciliationdoesn't exist at v0.15.0. Its replacement comes fromDispatcher.deleteWorkspace.Stack 3/5. Review and merge in order:
Refs DOCS-1171