Improve documentation

logger/logger.go

@@ -1,3 +1,9 @@
+// Package logger provides logging capabilities.
+// It is a wrapper around zerolog for logging and lumberjack for log rotation.
+// It provides a request logger to log the HTTP requests for REST API too.
+// The request logger uses chi.middleware.RequestLogger,
+// chi.middleware.LogFormatter and chi.middleware.LogEntry to build a structured
+// logger using zerlog
 package logger
 
 import (
@@ -15,12 +21,13 @@ var (
 	logger zerolog.Logger
 )
 
-// GetLogger get the logger instance
+// GetLogger get the configured logger instance
 func GetLogger() *zerolog.Logger {
 	return &logger
 }
 
-// InitLogger initialize loggers
+// InitLogger configures the logger.
+// It sets the log file path and the log level
 func InitLogger(logFilePath string, level zerolog.Level) {
 	logMaxSize := 10 // MB
 	logMaxBackups := 5
@@ -36,22 +43,22 @@ func InitLogger(logFilePath string, level zerolog.Level) {
 	}).With().Timestamp().Logger().Level(level)
 }
 
-// Debug log at debug level for sender
+// Debug logs at debug level for the specified sender
 func Debug(sender string, format string, v ...interface{}) {
 	logger.Debug().Str("sender", sender).Msg(fmt.Sprintf(format, v...))
 }
 
-// Info log at info level for sender
+// Info logs at info level for the specified sender
 func Info(sender string, format string, v ...interface{}) {
 	logger.Info().Str("sender", sender).Msg(fmt.Sprintf(format, v...))
 }
 
-// Warn log at warn level for sender
+// Warn logs at warn level for the specified sender
 func Warn(sender string, format string, v ...interface{}) {
 	logger.Warn().Str("sender", sender).Msg(fmt.Sprintf(format, v...))
 }
 
-// Error log at error level for sender
+// Error logs at error level for the specified sender
 func Error(sender string, format string, v ...interface{}) {
 	logger.Error().Str("sender", sender).Msg(fmt.Sprintf(format, v...))
 }
@@ -68,7 +75,7 @@ func TransferLog(operation string, path string, elapsed int64, size int64, user
 		Msg("")
 }
 
-// CommandLog log an SFTP command
+// CommandLog logs an SFTP command
 func CommandLog(command string, path string, target string, user string, connectionID string) {
 	logger.Info().
 		Str("sender", command).

logger/request_logger.go

@@ -9,23 +9,28 @@ import (
 	"github.com/rs/zerolog"
 )
 
-// StructuredLogger that uses zerolog
+// StructuredLogger defines a simple wrapper around zerolog logger.
+// It implements chi.middleware.LogFormatter interface
 type StructuredLogger struct {
 	Logger *zerolog.Logger
 }
 
-// StructuredLoggerEntry using zerolog logger
+// StructuredLoggerEntry defines a log entry.
+// It implements chi.middleware.LogEntry interface
 type StructuredLoggerEntry struct {
+	// The zerolog logger
 	Logger *zerolog.Logger
+	// fields to write in the log
 	fields map[string]interface{}
 }
 
-// NewStructuredLogger returns RequestLogger
+// NewStructuredLogger returns a chi.middleware.RequestLogger using our StructuredLogger.
+// This structured logger is called by the chi.middleware.Logger handler to log each HTTP request
 func NewStructuredLogger(logger *zerolog.Logger) func(next http.Handler) http.Handler {
 	return middleware.RequestLogger(&StructuredLogger{logger})
 }
 
-// NewLogEntry creates a new log entry
+// NewLogEntry creates a new log entry for an HTTP request
 func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
 	scheme := "http"
 	if r.TLS != nil {
@@ -47,7 +52,7 @@ func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
 	return &StructuredLoggerEntry{Logger: l.Logger, fields: fields}
 }
 
-// Write a new entry
+// Write logs a new entry at the end of the HTTP request
 func (l *StructuredLoggerEntry) Write(status, bytes int, elapsed time.Duration) {
 	l.Logger.Info().Fields(l.fields).Int(
 		"resp_status", status).Int(