imjasonh/clog
1
0
Fork 0
mirror of https://github.com/chainguard-dev/clog synced 2026-07-06 22:12:46 +00:00
Code Activity

docs: fix doc comments for clog.Logger (#36)

Browse source 
This updates doc comments and parameter names for the Logger type to be
friendlier to docs-aware editors, specifically by:

- Fixing when method name in doc comment didn't match the method name
- Using "msg" instead of "format" to align with the stdlib for when log
messages aren't formats
- Updating to explain how the variadic `args` params are used

Signed-off-by: Dan Luhring <dluhring@chainguard.dev>
This commit is contained in:
Dan Luhring 2025-04-23 19:03:34 -04:00 • committed by GitHub
parent fa6bbc4954
commit b5e6d19489
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

44
logger.go
View file

@ -41,7 +41,7 @@ func New(h slog.Handler) *Logger {
return NewWithContext(context.Background(), h) return NewWithContext(context.Background(), h)
} }
// New returns a new logger that wraps the given [slog.Handler]. // NewWithContext returns a new logger that wraps the given [slog.Handler] using the given context.
func NewWithContext(ctx context.Context, h slog.Handler) *Logger { func NewWithContext(ctx context.Context, h slog.Handler) *Logger {
return NewLoggerWithContext(ctx, slog.New(NewHandler(h))) return NewLoggerWithContext(ctx, slog.New(NewHandler(h)))
} }
@ -68,9 +68,9 @@ func (l *Logger) context() context.Context {
return l.ctx return l.ctx
} }
// Infof logs at LevelInfo with the given format and arguments. // Info logs at LevelInfo with the given message and treats the args as key/value pairs to form log message attributes.
func (l *Logger) Info(format string, args ...any) { func (l *Logger) Info(msg string, args ...any) {
wrap(l.context(), l, slog.LevelInfo, format, args...) wrap(l.context(), l, slog.LevelInfo, msg, args...)
} }
// Infof logs at LevelInfo with the given format and arguments. // Infof logs at LevelInfo with the given format and arguments.
@ -78,14 +78,14 @@ func (l *Logger) Infof(format string, args ...any) {
wrapf(l.context(), l, slog.LevelInfo, format, args...) wrapf(l.context(), l, slog.LevelInfo, format, args...)
} }
// InfoContextf logs at LevelInfo with the given context, format and arguments. // InfoContextf logs at LevelInfo with the given context, format, and arguments.
func (l *Logger) InfoContextf(ctx context.Context, format string, args ...any) { func (l *Logger) InfoContextf(ctx context.Context, format string, args ...any) {
wrapf(ctx, l, slog.LevelInfo, format, args...) wrapf(ctx, l, slog.LevelInfo, format, args...)
} }
// Warn logs at LevelWarn with the given format and arguments. // Warn logs at LevelWarn with the given message and treats the args as key/value pairs to form log message attributes.
func (l *Logger) Warn(format string, args ...any) { func (l *Logger) Warn(msg string, args ...any) {
wrap(l.context(), l, slog.LevelWarn, format, args...) wrap(l.context(), l, slog.LevelWarn, msg, args...)
} }
// Warnf logs at LevelWarn with the given format and arguments. // Warnf logs at LevelWarn with the given format and arguments.
@ -98,9 +98,9 @@ func (l *Logger) WarnContextf(ctx context.Context, format string, args ...any) {
wrapf(ctx, l, slog.LevelWarn, format, args...) wrapf(ctx, l, slog.LevelWarn, format, args...)
} }
// Error logs at LevelError with the given format and arguments. // Error logs at LevelError with the given message and treats the args as key/value pairs to form log message attributes.
func (l *Logger) Error(format string, args ...any) { func (l *Logger) Error(msg string, args ...any) {
wrap(l.context(), l, slog.LevelError, format, args...) wrap(l.context(), l, slog.LevelError, msg, args...)
} }
// Errorf logs at LevelError with the given format and arguments. // Errorf logs at LevelError with the given format and arguments.
@ -113,9 +113,9 @@ func (l *Logger) ErrorContextf(ctx context.Context, format string, args ...any)
wrapf(ctx, l, slog.LevelError, format, args...) wrapf(ctx, l, slog.LevelError, format, args...)
} }
// Debug logs at LevelDebug with the given format and arguments. // Debug logs at LevelDebug with the given message and treats the args as key/value pairs to form log message attributes.
func (l *Logger) Debug(format string, args ...any) { func (l *Logger) Debug(msg string, args ...any) {
wrap(l.context(), l, slog.LevelDebug, format, args...) wrap(l.context(), l, slog.LevelDebug, msg, args...)
} }
// Debugf logs at LevelDebug with the given format and arguments. // Debugf logs at LevelDebug with the given format and arguments.
@ -128,25 +128,25 @@ func (l *Logger) DebugContextf(ctx context.Context, format string, args ...any)
wrapf(ctx, l, slog.LevelDebug, format, args...) wrapf(ctx, l, slog.LevelDebug, format, args...)
} }
// Fatalf logs at LevelError with the given format and arguments, then exits.
func (l *Logger) Fatalf(format string, args ...any) {
wrapf(l.context(), l, slog.LevelError, format, args...)
os.Exit(1)
}
// Fatal logs at LevelError with the given message, then exits. // Fatal logs at LevelError with the given message, then exits.
func (l *Logger) Fatal(msg string, args ...any) { func (l *Logger) Fatal(msg string, args ...any) {
wrap(l.context(), l, slog.LevelError, msg, args...) wrap(l.context(), l, slog.LevelError, msg, args...)
os.Exit(1) os.Exit(1)
} }
// FatalfContextf logs at LevelError with the given context, format and arguments, then exits. // Fatalf logs at LevelError with the given format and arguments, then exits.
func (l *Logger) Fatalf(format string, args ...any) {
wrapf(l.context(), l, slog.LevelError, format, args...)
os.Exit(1)
}
// FatalContextf logs at LevelError with the given context, format and arguments, then exits.
func (l *Logger) FatalContextf(ctx context.Context, format string, args ...any) { func (l *Logger) FatalContextf(ctx context.Context, format string, args ...any) {
wrapf(ctx, l, slog.LevelError, format, args...) wrapf(ctx, l, slog.LevelError, format, args...)
os.Exit(1) os.Exit(1)
} }
// FatalfContext logs at LevelError with the given context and message, then exits. // FatalContext logs at LevelError with the given context and message, then exits.
func (l *Logger) FatalContext(ctx context.Context, msg string, args ...any) { func (l *Logger) FatalContext(ctx context.Context, msg string, args ...any) {
wrap(ctx, l, slog.LevelError, msg, args...) wrap(ctx, l, slog.LevelError, msg, args...)
os.Exit(1) os.Exit(1)