obs

Documentation

Overview

Package obs is the shared logging facade for internal/* packages (ADR-0003). It lets leaf packages emit log lines and sanitise user input without importing package main. package main wires the sink once at startup (SetSink) so these lines flow into the same rotating/JSON logger; before that, and in unit tests, the default sink writes to stderr.

Index

• func Printf(format string, args ...any)
• func Sanitize(s string) string
• func SetSink(fn func(line string))
• func Warnf(format string, args ...any)

Functions

func Printf

func Printf(format string, args ...any)

Printf formats at INFO level and sends the line to the configured sink.

func Sanitize

func Sanitize(s string) string

Sanitize strips control characters from s to prevent log injection (CWE-117).

This is an INDEPENDENT copy of package main's sanitizeLog (proxy.go), kept separate on purpose: CodeQL's CWE-117 query recognises the inline strings.ReplaceAll sanitiser at each call site, and delegating across a package boundary risks losing that recognition. The two copies are tiny and each behaviour-tested; the property (no control byte survives) is the contract.

func SetSink

func SetSink(fn func(line string))

SetSink publishes the log destination. Call once at startup, before serving traffic. A nil fn is ignored. Subsequent calls replace the sink atomically.

func Warnf

func Warnf(format string, args ...any)

Warnf formats with a WARN prefix and sends the line to the configured sink. Note: unlike package main's logWarnf, this does not apply main's runtime log-level filter (that state lives in main); internal warnings always emit.