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 Depth(log *slog.Logger, level slog.Level, depth int, msg string, args ...any)
- func Discard() *slog.Logger
- func From(c Contexter) *slog.Logger
- func FromContext(ctx context.Context) *slog.Logger
- func IsDiscard(log *slog.Logger) 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)
- type Contexter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Depth ¶ added in v0.47.0
Depth logs a message with the given call (pc skip) depth. This is useful for logging inside a helper function.
func From ¶ added in v0.48.0
From returns the Logger stored in c's context by NewContext, or the Discard logger if there is none. It is a companion to FromContext.
func FromContext ¶
FromContext returns the Logger stored in ctx by NewContext, or the Discard logger if there is none.
func IsDiscard ¶ added in v0.47.3
IsDiscard returns true if log was returned by lg.Discard.
func NewContext ¶
NewContext returns a context that contains the given Logger. Use FromContext to retrieve the Logger.
func Unexpected ¶
Unexpected is a convenience function for logging unexpected errors for which there may not be any useful context message.
func WarnIfCloseError ¶
WarnIfCloseError executes c.Close if is non-nil, and logs a warning if c.Close returns an error.
func WarnIfError ¶
WarnIfError logs a warning if err is non-nil.
Types ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package devlog contains a custom slog.Handler for developer-friendly log output.
|
Package devlog contains a custom slog.Handler for developer-friendly log output. |
|
Package lga ("log attribute") holds constants for log attribute names.
|
Package lga ("log attribute") holds constants for log attribute names. |
|
Package lgm ("log message") contains constants for log messages.
|
Package lgm ("log message") contains constants for log messages. |
|
Package lgt provides a mechanism for getting a *slog.Logger that outputs to testing.T. See lgt.New.
|
Package lgt provides a mechanism for getting a *slog.Logger that outputs to testing.T. See lgt.New. |
|
Package slogbuf implements a Buffer that stores log records that can later be replayed on a slog.Handler.
|
Package slogbuf implements a Buffer that stores log records that can later be replayed on a slog.Handler. |
|
Package userlogdir has a single function, UserLogDir, that returns an OS-specific path for storing user logs.
|
Package userlogdir has a single function, UserLogDir, that returns an OS-specific path for storing user logs. |