src/log.ts

Functions

Imports

It imports no other module of this repo. Imported by src/admin-client-audit.ts, src/agents.ts, src/auto-merge-tick.ts, src/backup.ts, src/bench.ts, src/controls-perform.ts, src/conventions-read.ts, src/dcr.ts, src/digest.ts, src/doc-index.ts, src/github/client.ts, src/index.ts, src/jobs-transition.ts, src/merge-safety.ts, src/merge-units.ts, src/model-drift.ts, src/ops-cloudflare.ts, src/ops-feed.ts, src/ops-otlp.ts, src/ops-packages.ts, src/ops-snapshot.ts, src/outcome-prs.ts, src/overnight-plan.ts, src/overnight.ts, src/portal-actions.ts, src/rate-limit.ts, src/routes.ts, src/routine-fire.ts, src/scope.ts, src/site-key.ts, src/site-repair.ts, src/site-watch.ts, src/stale-canon.ts, src/task-runs.ts, src/tick.ts, src/tools/repo-guards.ts, src/tools/repo.ts, src/trends.ts, src/watcher-findings.ts, src/watcher-gather.ts, src/watcher.ts.

Source

1// The one place the Worker writes a log line. Every line is a JSON object with an
2// upper-case `event` token to filter on and a `message` holding the human text, so a
3// log search can match the token exactly and a person still reads the sentence.
4//
5// This file depends on nothing in the Worker (no Env), so any module can import it.
6// It never throws: a log call sits inside catch blocks and cron steps, and a field
7// that cannot be serialised (a circular object, a BigInt) must not turn a handled
8// failure into a new one.
9
10export type LogLevel = "log" | "warn" | "error";
11
12export type LogFields = { message: string } & Record<string, unknown>;
13
14export function logEvent(level: LogLevel, event: string, fields: LogFields): void {
15  let line: string;
16  try {
17    const { message, event: _shadowed, ...rest } = fields;
18    line = JSON.stringify({ event, message, ...rest });
19  } catch {
20    line = `${event} ${String(fields.message)}`;
21  }
22  try {
23    console[level](line);
24  } catch {
25    // A console that throws has nowhere left to report to.
26  }
27}