lg

Documentation

Overview

Package lg contains utility functions for working with slog. It implements the slog.NewContext and slog.FromContext funcs that have recently been zapped from the slog proposal. I think you had it right the first time, Go team. Hopefully this package is short-lived and those funcs are put back.

Index

• func Discard() *slog.Logger
• func Error(log *slog.Logger, msg string, err error, args ...any)
• func FromContext(ctx context.Context) *slog.Logger
• func InContext(ctx context.Context) bool
• func NewContext(ctx context.Context, l *slog.Logger) context.Context
• func Unexpected(log *slog.Logger, err error)
• func WarnIfCloseError(log *slog.Logger, msg string, c io.Closer)
• func WarnIfError(log *slog.Logger, msg string, err error)
• func WarnIfFuncError(log *slog.Logger, msg string, fn func() error)

Functions

func Discard

func Discard() *slog.Logger

Discard returns a new *slog.Logger that discards output.

func Error

func Error(log *slog.Logger, msg string, err error, args ...any)

Error logs an error if err is non-nil.

func FromContext

func FromContext(ctx context.Context) *slog.Logger

FromContext returns the Logger stored in ctx by NewContext, or the Discard logger if there is none.

func InContext

func InContext(ctx context.Context) bool

InContext returns true if there's a logger on the context.

func NewContext

func NewContext(ctx context.Context, l *slog.Logger) context.Context

NewContext returns a context that contains the given Logger. Use FromContext to retrieve the Logger.

func Unexpected

func Unexpected(log *slog.Logger, err error)

Unexpected is a convenience function for logging unexpected errors for which there may not be any useful context message.

func WarnIfCloseError

func WarnIfCloseError(log *slog.Logger, msg string, c io.Closer)

WarnIfCloseError executes c.Close if is non-nil, and logs a warning if c.Close returns an error.

func WarnIfError

func WarnIfError(log *slog.Logger, msg string, err error)

WarnIfError logs a warning if err is non-nil.

func WarnIfFuncError

func WarnIfFuncError(log *slog.Logger, msg string, fn func() error)

WarnIfFuncError executes fn (if non-nil), and logs a warning if fn returns an error.