Skip to content

Commit cf56795

Browse files
committed
docs(adr): address maintainer review on ADR 0018
1 parent d730bd6 commit cf56795

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

‎docs/adr/0018-unified-event-journal.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ADR 0018: Unified request event journal
1+
# ADR 0018: Unified Request Event Journal
22

33
## Status
44

@@ -99,7 +99,7 @@ If a future feature needs journal visibility, it can separately opt in to a mirr
9999
Anything that would leave the machine must go through the closed `UsageRecord` schema.
100100
A later opt-in usage sink would project `session-lifecycle` events into a closed `UsageRecord`.
101101
It would use an allowlist by construction, not redaction of rich data.
102-
Its fields would be command or action from the CommandDescriptor registry; `ok` or a typed error code; `durationMs`, `runnerRoundTrips`, `nodeCount`, `platform`, and `appleOs`; flag names without values; and a hashed session identity with a per-session sequence number.
102+
Its fields would be command or action from the CommandDescriptor registry; `ok` or a typed error code from ADR 0010's closed set; `durationMs`, `runnerRoundTrips`, `nodeCount`, `platform`, and `appleOs`; flag names without values; and a hashed session identity with a per-session sequence number.
103103
Positionals, selectors, labels, fill text, snapshot content, and error messages would be unrepresentable.
104104
Sequence and anti-pattern detection would be downstream, never emission-side.
105105
A local stats read would come first and opt-in export later.
@@ -153,7 +153,8 @@ A wire name change remains a breaking change for log consumers, even though an i
153153

154154
The proposed journal would support request tracing by `requestId` and teardown tracing by `session`, while progress remains observable on the wire.
155155
New observability consumers could use sinks without new vocabularies or emit sites.
156-
The migration would retire the `traceLogPath` option, duplicate redaction pass, and unredacted replay helper.
156+
The migration would remove the duplicate redaction pass and the unredacted replay helper.
157+
The `traceLogPath` option stays until its callers move to the replay trace sink.
157158
Replay redaction would be the declared visible output change.
158159
The migration would be wide and would add one synchronous sink-dispatch loop per event.
159160

0 commit comments

Comments
 (0)