Documentation
¶
Overview ¶
Package logging carries a *slog.Logger through a context.Context, layered with attributes (file, package, stage, modroot, ...) as ctx flows deeper into a call chain. It is the sole mechanism CHOAM uses to attribute log output to the melange spec file being processed: ctx is already threaded everywhere for cancellation, so the logger rides along on it rather than being passed as a separate parameter or hung off a struct field.
Two invariants matter for correctness:
- Into REPLACES the logger stored on ctx; it never layers on top of a logger already stored there. slog does not dedupe attribute keys, so stacking a second "file" attribute onto an existing one would emit duplicate "file=" pairs on every record. Use With to add attributes - it reads the current logger, extends it, and replaces via Into in one step.
- From resolves slog.Default() lazily, at call time, not at package init or at the time Into was called. Tests routinely swap the default logger via slog.SetDefault mid-run; From must keep observing whichever default is current for any ctx that was never given its own logger.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ForFile ¶
ForFile returns a logger scoped to a melange spec file, for use before a processor.Processor (which would normally own this attribution) exists - e.g. while reading or parsing the file.
func From ¶
From returns the logger stored on ctx by Into, or slog.Default() if ctx carries none. The default is resolved at call time so it tracks any later slog.SetDefault.
func Into ¶
Into returns a copy of ctx carrying logger. It replaces any logger previously stored on ctx - see the package doc for why layering is unsafe.
func Library ¶
Library returns a copy of ctx carrying a clog logger - the logging facade chainguard-dev libraries such as omnibump read from ctx - that writes into From(ctx) (so records keep the file/modroot attribution), tagged source=name and demoted to Debug: what a library says about one simulated apply is diagnostic detail for -vv, not part of the operational stream.
func With ¶
With returns a copy of ctx whose logger has args appended, layering onto whatever logger ctx already carries (or slog.Default() if none). This is the safe way to add attributes as ctx descends a call chain - see the package doc for why calling Into directly with an unrelated logger is not.
Types ¶
This section is empty.
Source Files