feat(backend, logger): new setting on TOML that allows to specify a new path for the logger

Author: JavierRibaldelRio

backend/cmd/config.go

@@ -3,6 +3,7 @@ package main
 import (
 	"github.com/HyperloopUPV-H8/h9-backend/internal/server"
 	"github.com/HyperloopUPV-H8/h9-backend/internal/vehicle"
+	"github.com/HyperloopUPV-H8/h9-backend/pkg/logger"
 )
 
 type App struct {
@@ -46,7 +47,8 @@ type TCP struct {
 }
 
 type Logging struct {
-	TimeUnit string `toml:"time_unit"`
+	TimeUnit    logger.TimeUnit `toml:"time_unit"`
+	LoggingPath string          `toml:"logging_path"`
 }
 
 type Config struct {

backend/cmd/config.toml

@@ -53,7 +53,9 @@ backoff_factor = 2     # Backoff multiplier for retry delays
 enable_progress = true # Enable progress callbacks during transfers
 
 # Logger Configuration
+[logging]
 time_unit = "us"      # Time unit for log timestamps (ns, us, ms, s)  Default: ns
+logging_path = "."    # Absolute path of the logger
 
 # <-- DO NOT TOUCH BELOW THIS LINE -->
 

backend/cmd/dev-config.toml

@@ -84,4 +84,5 @@ file = "backend.log" # Log file path (empty to disable file logging)
 max_size_mb = 100    # Maximum log file size in MB
 max_backups = 3      # Number of backup files to keep
 max_age_days = 7     # Maximum age of log files in days
-time_unit = "us"      # Time unit for log timestamps (ns, us, ms, s)    
+time_unit = "us"      # Time unit for log timestamps (ns, us, ms, s)    
+logging_path = "."

backend/cmd/main.go

@@ -176,7 +176,7 @@ func main() {
 		order_logger.Name: order_logger.NewLogger(),
 	}
 
-	logger.SetFormatTimestamp(logger.TimeUnit(config.Logging.TimeUnit)) // MUST be before creating subloggers
+	logger.ConfigureLogger(config.Logging.TimeUnit, config.Logging.LoggingPath)
 	loggerHandler := logger.NewLogger(subloggers, trace.Logger)
 
 	// <--- order transfer --->

backend/pkg/logger/base/logger.go

@@ -56,16 +56,19 @@ func (sublogger *BaseLogger) Start() error {
 
 func (sublogger *BaseLogger) CreateFile(filename string) (*os.File, error) {
 
-	err := os.MkdirAll(path.Dir(filename), os.ModePerm)
+	// Includes the direcory specified by the user
+	baseFilename := path.Join(loggerHandler.BasePath, filename)
+
+	err := os.MkdirAll(path.Dir(baseFilename), os.ModePerm)
 	if err != nil {
 		return nil, loggerHandler.ErrCreatingAllDir{
 			Name:      sublogger.Name,
 			Timestamp: time.Now(),
-			Path:      filename,
+			Path:      baseFilename,
 		}
 	}
 
-	return os.Create(path.Join(filename))
+	return os.Create(path.Join(baseFilename))
 }
 
 // Create a base Logger with default values

backend/pkg/logger/logger.go

@@ -34,6 +34,8 @@ var _ abstraction.Logger = &Logger{}
 // Used on subloggers to get the current timestamp for folder or file names
 var Timestamp = time.Now()
 
+var BasePath = "."
+
 func (Logger) HandlerName() string { return HandlerName }
 
 func NewLogger(keys map[abstraction.LoggerName]abstraction.Logger, baseLogger zerolog.Logger) *Logger {
@@ -154,3 +156,13 @@ func (logger *Logger) Stop() error {
 	logger.trace.Info().Msg("stopped")
 	return nil
 }
+
+// Configures the logger atributes before inicialicing it
+func ConfigureLogger(unit TimeUnit, basePath string) {
+
+	// Start the sublogger
+	SetFormatTimestamp(unit)
+
+	// Update base Path
+	BasePath = basePath
+}