The sandbox itself

Logs

The sandbox's durable debug record

On this page(3 sections)

Logs the sandbox keeps
Read part of a log
Report what the browser saw

What log files exist, and a window of one. Captured terminal output, command runs, and the daemon's own log.

GET/logsLogs the sandbox keeps

Every log file the daemon owns: captured terminal output, command runs, and the daemon's own log. Read-only, because only the sandbox writes them.

What you send

Nothing. Call it as it is.

What comes back

Field	Type
`files`Every log the sandbox keeps: captured…	object[]
`name`Its name, which is what the…	string
`sizeBytes`Size in bytes	number
`modifiedAt`When it last changed, in milliseconds	number

Try itanswered in this tab

curl

curl "$SANDBOX/logs" \
  -H "x-intentic-control: $INTENTIC_TOKEN"

TypeScript

import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.logs.list();

GET/logs/fileRead part of a log

A window of one log file's text. A window rather than the whole thing, because a busy log outgrows any single answer.

What you send

Field	Type	Where
`name`requiredWhich log	string	query
`bytes`How much of the end to…	number	query

What comes back

Field	Type
`name`Which log this is from	string
`sizeBytes`How large the whole file is	number
`text`The end of it, as text	string
`truncated`There is more before what you…	boolean

Try itanswered in this tab

curl

curl "$SANDBOX/logs/file?name=nightly%20changelog" \
  -H "x-intentic-control: $INTENTIC_TOKEN"

TypeScript

import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.logs.read({
  "name": "nightly changelog"
});

POST/logs/clientReport what the browser saw

Errors the app caught, stalls it measured, and recoveries it performed, written to a log of their own. The browser is the only witness to these, so without it a bug someone hit in their own browser leaves no record at all.

What you send

Field	Type	Where
`events`requiredWhat the browser has to report,…	object[]	body
`seenAt`requiredWhen the browser saw it, in…	number	body
`level`requiredHow bad it was	"warn" \| "error"	body
`event`requiredWhat kind of thing it was,…	string	body
`message`requiredWhat it said	string	body
`route`Which page they were on	string	body
`requestId`Which daemon call it belonged to,…	string	body
`build`Which build of the app was…	string	body
`fields`Whatever else was worth keeping	object	body
`page`Which page load sent the batch	object	body
`pageId`requiredThis page load's own id: every…	string	body
`tabId`The browser tab's id, which a…	string	body
`userAgent`The browser's own description of itself	string	body
`viewport`The window's size in CSS pixels…	string	body
`replay`The PostHog session id, whose replay…	string	body
`origin`The address the page was loaded…	string	body
`served`How the page was served: `dev`…	string	body
`commit`The short commit the page's build…	string	body

What comes back

Field	Type
`recorded`How many were written down	number

Try itanswered in this tab

curl

curl -X POST "$SANDBOX/logs/client" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"events":[{"seenAt":1,"level":"warn","event":"…","message":"Fix the flaky parser test","route":"…","requestId":"a1b2c3d4","build":"…","fields":{"src/app.ts":"…","README.md":"…"}},{"seenAt":1,"level":"error","event":"…","message":"Fix the flaky parser test","route":"…","requestId":"a1b2c3d4","build":"…","fields":{"src/app.ts":"…","README.md":"…"}}],"page":{"pageId":"a1b2c3d4","tabId":"a1b2c3d4","userAgent":"…","viewport":"…","replay":"…","origin":"…","served":"…","commit":"9f2c1ab3d4e5f60718293a4b5c6d7e8f90a1b2c3"}}'

TypeScript

import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.logs.report({
  "events": [
    {
      "seenAt": 1,
      "level": "warn",
      "event": "…",
      "message": "Fix the flaky parser test",
      "route": "…",
      "requestId": "a1b2c3d4",
      "build": "…",
      "fields": {
        "src/app.ts": "…",
        "README.md": "…"
      }
    },
    {
      "seenAt": 1,
      "level": "error",
      "event": "…",
      "message": "Fix the flaky parser test",
      "route": "…",
      "requestId": "a1b2c3d4",
      "build": "…",
      "fields": {
        "src/app.ts": "…",
        "README.md": "…"
      }
    }
  ],
  "page": {
    "pageId": "a1b2c3d4",
    "tabId": "a1b2c3d4",
    "userAgent": "…",
    "viewport": "…",
    "replay": "…",
    "origin": "…",
    "served": "…",
    "commit": "9f2c1ab3d4e5f60718293a4b5c6d7e8f90a1b2c3"
  }
});