Back to all reviewers

Use structured logging framework

docker/compose
Based on 2 comments
Go

Prefer structured logging frameworks like logrus over direct fmt output functions for consistency, proper log levels, and better log management. This ensures uniform logging behavior across the codebase and enables proper log level filtering and formatting.

Logging Go

Reviewer Prompt

Prefer structured logging frameworks like logrus over direct fmt output functions for consistency, proper log levels, and better log management. This ensures uniform logging behavior across the codebase and enables proper log level filtering and formatting.

Use logrus methods with appropriate log levels instead of fmt.Printf, fmt.Fprintf, or fmt.Fprintln for application messages:

// Instead of:
fmt.Fprintf(s.stderr(), "Failed to parse aux message: %s", err)
_, _ = fmt.Fprintln(out, "Terminal is not a POSIX console")

// Use:
logrus.Errorf("Failed to parse aux message: %s", err)
logrus.Warning("Terminal is not a POSIX console")

Choose the appropriate log level (Debug, Info, Warn, Error, Fatal) based on the message severity. Reserve fmt functions only for direct user output or when specifically required to write to particular streams.

2
Comments Analyzed
Go
Primary Language
Logging
Category

Source Discussions