Skip to content

docs: document sidecar stderr forwarding and host-backed filesystem budget#1815

Open
NathanFlurry wants to merge 1 commit into
stack/fix-native-sidecar-stop-stranding-child-process-fd_read-on-mapped-fds-qrmuouksfrom
stack/docs-document-sidecar-stderr-forwarding-and-host-backed-filesystem-budget-pkwturou
Open

docs: document sidecar stderr forwarding and host-backed filesystem budget#1815
NathanFlurry wants to merge 1 commit into
stack/fix-native-sidecar-stop-stranding-child-process-fd_read-on-mapped-fds-qrmuouksfrom
stack/docs-document-sidecar-stderr-forwarding-and-host-backed-filesystem-budget-pkwturou

Conversation

@NathanFlurry

Copy link
Copy Markdown
Member

Both are user-facing behavior changes that shipped without docs.

  • debugging.mdx: sidecar logs are forwarded to the host's stderr as they
    arrive, so a still-running sidecar's warnings are visible rather than only
    replayed if it dies. Notes the bounded postmortem excerpt (first 16 KiB +
    last 48 KiB, truncation stated inline) and points at AGENTOS_LOG_FILE for
    the complete log.

  • resource-limits.mdx: maxFilesystemBytes now also governs host-backed paths,
    which never reach the virtual filesystem and so are checked separately on
    write. Documents the honest caveat that this separate check is per-file
    while the VFS side is per-VM total, so a guest can still exceed its budget
    by spreading data across many host-backed files, and recommends bounding
    the host directory until that check aggregates per VM.

The interim AGENTOS_SIDECAR_STDERR knob is intentionally not documented: it
was removed in favor of unconditional forwarding to match the Rust client.

Not validated with pnpm --dir website build: website is excluded from the
workspace in this checkout by a pre-existing local workaround, so the build
cannot run here. MDX table/fence structure was checked instead.

…udget

Both are user-facing behavior changes that shipped without docs.

- debugging.mdx: sidecar logs are forwarded to the host's stderr as they
  arrive, so a still-running sidecar's warnings are visible rather than only
  replayed if it dies. Notes the bounded postmortem excerpt (first 16 KiB +
  last 48 KiB, truncation stated inline) and points at AGENTOS_LOG_FILE for
  the complete log.

- resource-limits.mdx: maxFilesystemBytes now also governs host-backed paths,
  which never reach the virtual filesystem and so are checked separately on
  write. Documents the honest caveat that this separate check is per-file
  while the VFS side is per-VM total, so a guest can still exceed its budget
  by spreading data across many host-backed files, and recommends bounding
  the host directory until that check aggregates per VM.

The interim AGENTOS_SIDECAR_STDERR knob is intentionally not documented: it
was removed in favor of unconditional forwarding to match the Rust client.

Not validated with `pnpm --dir website build`: `website` is excluded from the
workspace in this checkout by a pre-existing local workaround, so the build
cannot run here. MDX table/fence structure was checked instead.
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.

1 participant