slogkv

README

docs

Documentation

Overview

Package slogkv provides a go/analysis analyzer enforcing the gomatic structured- logging standard: a leveled slog call (slog.Info/Warn/Error/Debug, or the same methods on a *slog.Logger) passes its attributes as constant-string key/value pairs — an even number of trailing arguments whose keys are constant strings.

Calls that pass any slog.Attr argument (or an alias of it) are intentionally not checked: mixing pre-built attributes with loose pairs is a valid, harder-to-verify shape, so the analyzer skips it rather than risk a false positive. Spread calls (slog.Info(msg, kvs...)) are likewise skipped — the spread contents are not statically knowable. Dot-imported calls and method expressions ((*slog.Logger).Info(l, ...)) are checked; method values (f := slog.Info; f(...)) are out of scope, because once the function is bound to a plain variable the call site no longer names a slog entrypoint.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "slogkv",
	Doc:      "reports leveled slog calls whose key/value arguments are unpaired or use a non-constant key",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
}

Analyzer reports malformed key/value arguments to leveled slog calls.

var Registration = goyze.Registration{
	Name:       "slogkv",
	Categories: []goyze.Category{"logging"},
	URL:        "https://docs.gomatic.dev/yze/slogkv",
	Analyzer:   Analyzer,
}

Registration declares this analyzer to the yze framework.