go-logr implementation with pterm
This project is archived, as it's not needed anymore with the introduction of log/slog in Go 1.21 and pterm's direct support.
You can easily achieve a very similar experience with pterm and slog directly:
handler := pterm.NewSlogHandler(&pterm.DefaultLogger)
pterm.DefaultLogger.Level = pterm.LogLevelInfo
pterm.DefaultLogger.ShowCaller = true
pterm.DefaultLogger.CallerOffset = 2
slogger := slog.New(handler)
slog.SetDefault(slogger)
ctx := logr.NewContextWithSlogLogger(context.Background(), slogger)
log := logr.FromContextOrDiscard(ctx)
log.Info("message", "key", "value")Sure, the log output is slightly different, but this is not worth further maintaining this project. Less code and dependencies is better in most cases anyway.
See examples
By default, only level 0 (info) and level 1 (debug) are configured.
While go-logr doesn't have names for logging levels ("info", "warning", etc), pterm does. Both libraries agree that verbosity is increased with higher numeric logging level. For pterm however, one could argue that their "Warning" and "Success" levels have lower verbosity than "Info". If you like to customize the levels or styling, you could do something like this:
func main() {
sink := plogr.NewPtermSink().
SetLevelPrinter(3, pterm.Debug).
SetLevelPrinter(2, plogr.DefaultLevelPrinters[0]).
SetLevelPrinter(1, pterm.Success).
SetLevelPrinter(0, pterm.Warning)
logger := logr.New(sink)
logger.V(0).WithName("main").Info("Warning message")
logger.V(1).WithName("app").Info("Success message")
logger.V(2).WithName("database").Info("Info message", "key", "value")
logger.V(3).WithName("controller").Info("Debug message")
}
That means whenever you want to show informational messages, you'd have to set the logging level to 2 in your code base.
Alternatively, without breaking the code base, append levels like success to the LevelPrinters to your desired level, disregarding the verbosity increase though.
For a logging library, it remains questionable though if you'd like to maintain warnings and success levels via plogr or whether they're better explicitly invoked in pterm.
The error printer can be customized as well, but it has its own field.