Skip to content

Commit 26e6b5b

Browse files
committed
docs: fix browser telemetry README inaccuracies
- mention browsers create as a --telemetry surface (not just update) - document partial-update semantics for per-category config - note default --seq behavior (omit to stream from now) - correct the default output example to call out tab-separated format
1 parent 6df0ac3 commit 26e6b5b

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -291,18 +291,20 @@ Commands with JSON output support:
291291

292292
### Browser Telemetry
293293

294-
Telemetry config is a sub-field of the browser session. Use `browsers update` to enable, disable, or configure it, and `browsers get` to inspect the current state.
294+
Telemetry config is a sub-field of the browser session. Use `browsers create` or `browsers update` to enable, disable, or configure it, and `browsers get` to inspect the current state.
295295

296296
- Enable all categories: `kernel browsers update <id> --telemetry=all`
297297
- Disable: `kernel browsers update <id> --telemetry=off`
298298
- Per-category: `kernel browsers update <id> --telemetry=network=on,page=off` (valid: `console`, `interaction`, `network`, `page`; `system` always emits and cannot be toggled)
299299

300+
Per-category updates are partial — only categories you name are changed; others retain their current state. `--telemetry=all` and `--telemetry=off` reset the entire config.
301+
300302
- `kernel browsers telemetry stream <id>` - Stream live telemetry events (NDJSON with `-o json`)
301-
- `--categories <list>` - Filter by API event category (console,network,page,interaction,system); `system` covers all `monitor_*` events
302-
- `--types <list>` - Filter by event type (e.g. network_response,console_error)
303-
- `--seq <n>` - Resume stream from sequence number (Last-Event-ID); `--seq=0` resumes from the beginning
303+
- `--categories <list>` - Filter by event category (`console`, `network`, `page`, `interaction`, `system`); `system` matches `monitor_*` event types
304+
- `--types <list>` - Filter by event type (e.g. `network_response`, `console_error`)
305+
- `--seq <n>` - Resume from sequence number (Last-Event-ID); `--seq=0` replays from the beginning. Omit to stream from now.
304306
- `-o, --output json` - Output newline-delimited JSON envelopes
305-
- Default output: `15:04:05 [network] network_response`
307+
- Default output: tab-separated `<time>\t[<category>]\t<type>`, e.g. `15:04:05 [network] network_response`
306308

307309
### Browser Process Control
308310

0 commit comments

Comments
 (0)