ludic/docs/language/log/log-trace.md
Orkuncakilkaya 031b138f84
All checks were successful
docs / build-and-deploy (push) Successful in 2s
feat(stdlib): add Log.* — levelled, structured logging (#15)
A Log.* namespace: five levels (trace/debug/info/warn/error), a runtime
threshold, and structured key=value fields, so games get something better than
scattered print calls and release builds can go quiet without touching call
sites.

  - Log.trace/debug/info/warn/error(msg, [k, v]...)  -> stderr, "[LEVEL] msg k=v"
  - Log.set_level(n)   show only level >= n (0 = all default, 5 silences all)
  - Log.level()        read the current threshold

Fields accept strings, ints, and longs (numbers formatted automatically); the
level tag is chosen at compile time so a filtered-out level costs only a
comparison. Writes to stderr, never touching the simulation — no effect on
determinism/replays. v1 is the console sink; rotating-file and in-engine overlay
sinks are noted as follow-ups.

- examples/library/logging.ludic: asserts the set_level/level threshold
  round-trip and that every level (with mixed-type fields) runs without faulting;
  the stderr gating itself was verified by hand (warn/error emit, lower levels
  suppressed). Wired into `x test` (now 53 passed).
- docs: a new Log section + per-symbol pages; inventory and coverage pass.
- seed regenerated; `x bootstrap-cfree` fixpoint holds.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-30 21:57:22 +03:00

27 lines
967 B
Markdown

---
id: log-trace
name: Log.trace
category: log
kind: namespace-method
tokens: Log.trace
sig: Log.trace(msg, [key, value]...) -> void
tip: Log at the trace level (0) — the most verbose.
order: 1
ns: Log
member: trace
---
Logs <code>msg</code> at the **trace** level (0), the most verbose — the fine-grained "I am here, this is the value" tracing you turn on only when hunting a specific problem. It appears on stderr as <code>[TRACE] msg</code>, followed by any structured <code>key=value</code> fields, but only when the threshold set by <a href="log-set_level"><code>Log.set_level</code></a> is 0. Because trace is usually filtered out, keep the calls wherever they help; a disabled level costs only a comparison.
Parameters:
- `msg` — the message string
- `key, value...` — optional trailing pairs; values may be strings or numbers
```ludic
program Trace {
entry {
Log.set_level(0)
Log.trace("spawned entity", "id", 7, "at", "cave")
}
}
```