close
Skip to content

feat(workspace): log workspace and agent state changes - #1075

Merged
aqandrew merged 24 commits into
mainfrom
aqandrew/devex-661-connection-state-logs
Aug 21, 2026
Merged

feat(workspace): log workspace and agent state changes#1075
aqandrew merged 24 commits into
mainfrom
aqandrew/devex-661-connection-state-logs

Conversation

@aqandrew

@aqandrew aqandrew commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

What

Add info-level logging of workspace, agent, and lifecycle status transitions so connection debugging has a record of state changes — correlated by the session ID from #1073.

This is Phase 3 of 3 for DEVEX-661 (RFC req 7). It builds on #1074.

Changes

State handling is split into three layers, one job each:

  • detectWorkspaceStateObserver / WorkspaceAgentObserver (src/instrumentation/workspace.ts) each detect a transition once and report a transition object. Stateful but effect-free (no logger/telemetry imports). The agent observer tracks every agent by ID and reports agents that disappear.
  • recordrecordWorkspaceState / recordAgentState emit the workspace.state_transitioned / workspace.agent.state_transitioned telemetry events.
  • log — inline in WorkspaceMonitor.update(), with flat scalar payloads matching the repo's other log sites. Logs state observed on first sight, state changed afterward, and agent <name> removed when an agent disappears.

WorkspaceMonitor is now the single agent-observation site, so WorkspaceStateMachine no longer tracks agent telemetry.

Important

Telemetry data change. workspace.agent.state_transitioned now covers every agent for the whole monitored session (deduped per agent), rather than only the connected agent during connection setup. In practice most workspaces have one agent, so volume is unchanged; multi-agent workspaces and flaky connections emit more. There is no sampling in src/telemetry/, so this lands as-is. EVENTS.md is updated; heads-up to whoever owns the funnel queries.

Testing

  • pnpm typecheck, targeted pnpm lint, full pnpm test (2456 passing).
  • Unit tests cover observer detection (first observation, dedup, per-agent independence, removal, reset), the record* event shapes, and the monitor's inline logging (observed vs changed, agent transitions across all agents, agent removal).
Refactor design (reviewer's three-layer shape)

Per the review, the goal was to remove the duplication between the telemetry observers and the state loggers by making transition detection happen once:

  • detect: pure-detection observers report a transition object; no logger or telemetry imports.
  • record: recordWorkspaceState / recordAgentState in src/instrumentation/, telemetry only.
  • log: inline in the monitor, same as every other logging call site.

This deletes both src/workspace/*Logger.ts files and leaves one tracker per concern.

Observer API decision: observers return a transition object (workspace → WorkspaceStateTransition | undefined; agents → { transitions, removed }) and WorkspaceMonitor.update() logs inline and calls record*. This was chosen over a constructor callback because observe() has a single synchronous caller, so a callback would only hide the side effects and complicate tests.


🤖 Generated by Coder Agents.

@linear-code

linear-code Bot commented Aug 11, 2026

Copy link
Copy Markdown

DEVEX-661

DEVEX-666

@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from a1a27aa to 163a89b Compare August 12, 2026 22:00
@aqandrew
aqandrew requested review from EhabY and code-asher August 12, 2026 22:35
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 163a89b to 082b4bb Compare August 13, 2026 00:40
Comment thread src/workspace/workspaceStateLogger.ts Outdated
Comment thread src/workspace/workspaceStateLogger.ts Outdated
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 082b4bb to 163a89b Compare August 13, 2026 18:46
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 163a89b to d29fcbd Compare August 13, 2026 20:26
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch 2 times, most recently from 7f7439a to 370185b Compare August 13, 2026 23:51
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 370185b to b69ba41 Compare August 13, 2026 23:54
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from b69ba41 to 4e8b8c8 Compare August 14, 2026 00:02
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch 5 times, most recently from 3c2be68 to 1fc0b0b Compare August 14, 2026 00:59
@EhabY

EhabY commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Should we include an entry in the changelog for the past 2 PRs + this? We only mention user-visible changes and these are worthy of it since it means sharing the logs or browsing them would give them an easy way to correlate logs to sessions. (also more logs so they can easily debug more)

@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 1fc0b0b to 0991842 Compare August 17, 2026 20:21
Base automatically changed from aqandrew/devex-661-session-id-requests to main August 17, 2026 20:49
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 0991842 to b1a22a8 Compare August 17, 2026 20:49
…gers

Address review feedback on the combined WorkspaceStateLogger: it logged
once per agent for a single workspace-status change and duplicated the
transition-detection already in the telemetry observers.

- Add a shared TransitionTracker and use it in WorkspaceStateTelemetry and
  WorkspaceAgentTelemetry (no behavior change).
- Split the logger into WorkspaceStateLogger (one log per workspace status
  change) and WorkspaceAgentLogger (per-agent status/lifecycle), mirroring
  the two telemetry observers. Both are wired in WorkspaceMonitor.
Mirror WorkspaceStateTelemetry: key the workspace state logger on status,
transition, and reason, and include transition and reason in the log
payload so a state-change line matches the telemetry event.
…lemetry

Reshape workspace/agent state handling into three layers, one job each:

- detect: WorkspaceStateObserver / WorkspaceAgentObserver report a
  transition object; stateful but effect-free (no logger/telemetry imports)
- record: recordWorkspaceState / recordAgentState emit telemetry
- log: inline in WorkspaceMonitor.update, matching the repo's other log sites

Deletes the parallel WorkspaceStateLogger / WorkspaceAgentLogger classes and
the WorkspaceStateTelemetry / WorkspaceAgentTelemetry classes. Agent state is
now observed once in WorkspaceMonitor for every agent over the whole session,
so WorkspaceStateMachine no longer tracks agent telemetry. Logs use flat
scalar payloads and say "state observed" on first sight, "state changed"
after, and log when an agent disappears.
The event now covers every agent for the whole monitored session (deduped),
not just the connected agent during connection setup, and transitions are
sampled from the workspace event stream so intermediate hops may coalesce.
Per CONVENTIONS.md, src/instrumentation is telemetry-only. The pure
detection code has no telemetry or logger imports, so move TransitionTracker,
WorkspaceStateObserver, WorkspaceAgentObserver, and the transition types to
src/workspace/observers.ts. The record* functions stay in instrumentation and
import the transition types from there. Observer/tracker tests move to
test/unit/workspace/observers.test.ts.
@aqandrew
aqandrew force-pushed the aqandrew/devex-661-connection-state-logs branch from 0c10123 to 8400c8b Compare August 19, 2026 23:46
Drop the generic TransitionTracker. It was only used by the two observers,
and the shared wrapper forced the awkward "nothing changed" / "first
observation" double-check. Each observer now keeps its own previous-state
memory and compares inline, shaping its result directly.
@aqandrew
aqandrew requested a review from EhabY August 20, 2026 03:23

@EhabY EhabY left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shape looks right now, the three layers each do one job and the earlier duplication is gone. Just some small clean up left 🙏

Changelog. Still missing. The Unreleased section has no entry for the session ID or the state logs.

src/instrumentation/CONVENTIONS.md:9. The checklist says one instrumentation class per domain wrapping TelemetryService, and this PR replaces two such classes with the stateless recordWorkspaceState and recordAgentState functions. Either keep the methods but update the conventions or convert them into a class if there's some shared state that is useful.

Comment thread src/workspace/observers.ts Outdated
Comment thread src/workspace/observers.ts
Comment thread src/workspace/observers.ts Outdated
Comment thread src/workspace/observers.ts
Comment thread src/workspace/observers.ts Outdated
Comment thread src/workspace/workspaceMonitor.ts Outdated
Comment thread test/unit/workspace/workspaceMonitor.test.ts
Comment thread test/unit/workspace/observers.test.ts
Comment thread test/unit/workspace/workspaceMonitor.test.ts Outdated
Comment thread test/unit/workspace/workspaceMonitor.test.ts Outdated
…into AgentStateTransition"

This reverts commit 18bcfa2.
Drop the single-field RemovedAgent wrapper. AgentObservation.removed is now
string[], so the monitor iterates names directly and the observer test asserts
["second"].
buildStartedAtMs is set only while provisioning and cleared otherwise, so
wasProvisioning is exactly buildStartedAtMs !== undefined. Drop both locals
and fold the check into the else branch.
Dedup, build-duration resolution, and duration measurements are observer
behavior already covered in observers.test.ts. Keep the monitor telemetry test
to wiring only: the initial state records once and a later change records
again.
Mirror the workspace observer's transition/reason-only case: same status, new
lifecycle_state reports one transition.
observers.test.ts and workspaceMonitor.test.ts had the same workspace builder.
Move it to test/mocks/testHelpers, typed to take WorkspaceAgent[], and use it
from both.
The agent tests hand-rolled { type: "data", data }. Widen workspaceEvent to
accept a full Workspace and use it at both call sites.
@aqandrew
aqandrew requested a review from EhabY August 20, 2026 22:03

@EhabY EhabY left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks! :shipit:

@aqandrew
aqandrew merged commit 6f27d3a into main Aug 21, 2026
11 checks passed
@aqandrew
aqandrew deleted the aqandrew/devex-661-connection-state-logs branch August 21, 2026 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants