Logs (totalum-sdk/logs)

import … from 'totalum-sdk/logs' — or the same namespace on totalum from 'totalum-sdk'. Install, configuration and errors: Totalum SDK.

Read your app's own server logs: the requests the published app (env: 'live') or the preview ('dev') handled, with their console lines, status codes and errors. Use it for an admin page that shows recent errors, or to debug. Free.

const { items } = await totalum.logs.query({ level: 'error', env: 'live' });

#totalumLogs

totalumLogs(options?: TotalumClientOptions): TotalumLogs

Creates the logs namespace (the same object as totalum.logs, scope logs:read): the requests the published app (env: 'live') or the preview ('dev') handled, with their console lines and errors. Free.

Parameters

Returns TotalumLogs — The logs namespace: the method below.

Example

import { totalumLogs } from 'totalum-sdk/logs';

const logs = totalumLogs();
const { items } = await logs.query({ level: 'error' });

The namespace's type is exported as TotalumLogs (import type { TotalumLogs } from 'totalum-sdk/logs').

#logs.query

logs.query(q?: LogsQuery): Promise<LogsPage>

Reads the app's server logs, newest first: one item per request (or per console line), with its level, message, path, status and timings. Use it for an admin "recent errors" page or to debug. window in the answer is the window actually searched. Free.

Parameters

Returns Promise<LogsPage> — Up to limit (≤ 500) log items and the window searched.

Errors — besides the errors every call can throw:

Example

const { items } = await totalum.logs.query({ level: 'error', env: 'live', limit: 2 });

Result:

{
  "items": [
    {
      "ts": "2026-10-11T17:20:41.118Z",
      "level": "error",
      "message": "TypeError: Cannot read properties of undefined (reading 'id')",
      "requestId": "8f1c2a9e4b7d3c6a",
      "method": "POST",
      "path": "/api/orders",
      "status": 500,
      "cpuMs": 4.1,
      "wallMs": 37.9,
      "outcome": "ok",
      "exception": { "name": "TypeError", "message": "Cannot read properties of undefined (reading 'id')" }
    }
  ],
  "window": { "from": "2026-10-11T16:38:39.984Z", "to": "2026-10-11T17:38:39.984Z", "source": "live" },
  "nextCursor": null,
  "sampled": false
}

#LogsPage

Log items from logs.query().

#LogsQuery type

A logs.query filter: the time window (default the last hour), level, text, status, path, request id and environment; every field is optional.