refactor(upload): add logging formats

Author: philwinder

tools/upload/cmd/root.go

@@ -52,7 +52,10 @@ func initializeConfig(cmd *cobra.Command) error {
 
 	// Set global log level
 	zerolog.SetGlobalLevel(zerolog.Level(finalConfig.LogLevel))
-	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout})
+	// Set log format, defaults to json if format isn't "text"
+	if finalConfig.LogFormat == "text" {
+		log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout, NoColor: true})
+	}
 
 	return nil
 }
@@ -87,7 +90,7 @@ func executeRootCommand(cmd *cobra.Command, args []string) error {
 	log.Debug().Str("InputPath", conf.InputPath).Msg("Walking input path")
 	err = filepath.WalkDir(conf.InputPath, walker)
 	if err != nil {
-		fmt.Errorf("Error walking input path: %w", err)
+		return fmt.Errorf("walking input path: %w", err)
 	}
 
 	// Putting the objects in order so all Dirs come before all Files

tools/upload/config/global.go

@@ -10,12 +10,14 @@ import (
 // Define all global flag names
 const (
 	LogLevelFlag   = "log-level"
+	LogFormatFlag  = "log-format"
 	InputPathFlag  = "input"
 	OutputPathFlag = "output"
 )
 
 type GlobalConfig struct {
 	LogLevel   int    `yaml:"log-level"`
+	LogFormat  string `yaml:"log-format"`
 	InputPath  string `yaml:"input-path"`
 	OutputPath string `yaml:"output-path"`
 }
@@ -27,13 +29,15 @@ func ParseGlobalConfig(cmd *cobra.Command) (*GlobalConfig, error) {
 	}
 	return &GlobalConfig{
 		LogLevel:   number,
+		LogFormat:  cmd.Flag(LogFormatFlag).Value.String(),
 		InputPath:  filepath.Clean(cmd.Flag(InputPathFlag).Value.String()),
 		OutputPath: filepath.Clean(cmd.Flag(OutputPathFlag).Value.String()),
 	}, nil
 }
 
 func AddGlobalFlags(cmd *cobra.Command) *cobra.Command {
 	cmd.PersistentFlags().IntP(LogLevelFlag, "l", 1, "Logging level (-1= trace, 0=debug, 1=info, 2=warning, 3=error, ...")
+	cmd.PersistentFlags().StringP(LogFormatFlag, "", "text", "Logging format (json, text)")
 	cmd.PersistentFlags().StringP(InputPathFlag, "i", "/inputs", "Input path")
 	cmd.PersistentFlags().StringP(OutputPathFlag, "o", "/outputs", "Output path")
 	return cmd