Documentation Index
Fetch the complete documentation index at: https://smithers.sh/llms.txt
Use this file to discover all available pages before exploring further.
SmithersEvent is a discriminated union of every lifecycle event the runtime emits. The full type definition lives in Types — that’s the source of truth for field shapes.
Subscribe via onProgress
Read from the NDJSON log
Events append to.smithers/executions/<runId>/logs/stream.ndjson (configure with logDir / --log-dir; disable with --no-log).
Common fields
type, runId, timestampMs. Node-scoped events add nodeId and iteration. Attempt-scoped add attempt.
Event categories
Used bybunx smithers-orchestrator events --type <category> and the metrics layer.
| Category | Events |
|---|---|
run | RunAutoResumed, RunAutoResumeSkipped, RunStarted, RunStatusChanged, RunStateChanged, RunFinished, RunFailed, RunCancelled, RunContinuedAsNew, RunHijackRequested, RunHijacked, RetryTaskStarted, RetryTaskFinished, RunForked, ReplayStarted |
frame | FrameCommitted |
node | NodePending, NodeStarted, TaskHeartbeat, TaskHeartbeatTimeout, NodeFinished, NodeFailed, NodeCancelled, NodeSkipped, NodeRetrying, NodeWaitingApproval, NodeWaitingTimer |
approval | ApprovalRequested, ApprovalGranted, ApprovalAutoApproved, ApprovalDenied |
tool-call | ToolCallStarted, ToolCallFinished |
agent | AgentEvent, AgentTraceEvent, AgentTraceSummary, AgentSessionEvent |
output | NodeOutput |
revert | RevertStarted, RevertFinished, TimeTravelStarted, TimeTravelFinished, TimeTravelJumped |
workflow | WorkflowReloadDetected, WorkflowReloaded, WorkflowReloadFailed, WorkflowReloadUnsafe |
scorer | ScorerStarted, ScorerFinished, ScorerFailed |
token | TokenUsageReported |
timer | TimerCreated, TimerFired, TimerCancelled |
memory | MemoryFactSet, MemoryRecalled, MemoryMessageSaved |
openapi | OpenApiToolCalled |
sandbox | SandboxCreated, SandboxShipped, SandboxHeartbeat, SandboxBundleReceived, SandboxCompleted, SandboxFailed, SandboxDiffReviewRequested, SandboxDiffAccepted, SandboxDiffRejected |
snapshot | SnapshotCaptured |
supervisor | SupervisorStarted, SupervisorPollCompleted |
Built-in metrics
| Event | Metric |
|---|---|
RunStarted | smithers.runs.total |
NodeStarted | smithers.nodes.started |
NodeFinished | smithers.nodes.finished |
NodeFailed | smithers.nodes.failed |
ApprovalGranted / ApprovalDenied | Approval counters |
TokenUsageReported | Token usage counters per model/agent |
trackSmithersEvent from smithers-orchestrator/observability exposes this mapping for custom integrations. See the observability fragment for the full OTLP/Prometheus setup.