Skip to content

Commit 2863a27

Browse files
committed
Document how to follow operation logs
1 parent 9de0735 commit 2863a27

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,34 @@ installation, players, backend services, the site, or production deployment.
433433
stay forbidden. This is **source-ready** in the working tree. It is not in
434434
the locked plugin bundle. Do not claim marketplace or deployed.
435435

436+
## Follow operation logs
437+
438+
The CLI is a **client**. Optional `log_socket` lives in the same 0600 user
439+
config as the token (`src/config.ts`). `README.md` documents the field.
440+
There is no `--log-socket` flag and no `SCREENRIG_LOG_SOCKET` override
441+
(`src/commands.ts` USAGE).
442+
443+
If `log_socket` is absent or empty, commands work unchanged. If it is set,
444+
connect or write failure fails the command: the consumer must already be
445+
listening (`src/log/attach.ts`, `src/log/socket.ts`).
446+
447+
Each line is one v1 NDJSON object (`src/log/types.ts`): `v`, `ts`,
448+
`event_id`, `correlation_id`, `run_id`, `command`, `kind` (`http` or
449+
`local`), `phase`, `op`, `tag`, optional `id` / `params`. Pair HTTP
450+
request/response and local start/finish on `correlation_id`. Prefer `tag`
451+
(snake_case, for example `get_screens`). Optional `id` is the associated
452+
resource (`scr_…`, `pl_…`), never `event_id` or `correlation_id`. Optional
453+
`params` is small scalars.
454+
455+
This socket is not `events follow`. `events follow` is account SSE
456+
(`GET /api/v1/events/stream`).
457+
458+
To follow: start a listener on the configured path, then run the CLI
459+
command. The README example path is `/tmp/screenrig.sock`. Do not paste
460+
full NDJSON into reports. Prefer `tag`, `correlation_id`, `id`, `status` /
461+
`phase`. Never log or print credentials, cookies, `Authorization` headers,
462+
nonces, signed URLs, object keys, or pixels.
463+
436464
## Verification
437465

438466
```sh

0 commit comments

Comments
 (0)