feat: add flag to change log level

Signed-off-by: ludo <[email protected]>

cmd/container/main.go

@@ -10,7 +10,6 @@ import (
 	"github.com/controlplaneio/simulator/v2/core/tools"
 	"github.com/controlplaneio/simulator/v2/internal/cli"
 	"github.com/controlplaneio/simulator/v2/internal/config"
-	"github.com/controlplaneio/simulator/v2/internal/logging"
 )
 
 func main() {
@@ -21,9 +20,6 @@ func main() {
 	terraformWorkspaceDir := filepath.Join(simulatorDir, "terraform/workspaces/simulator")
 	ansiblePlaybookDir := filepath.Join(simulatorDir, "ansible/playbooks")
 
-	// configure slog
-	logging.Configure()
-
 	conf := config.Config{}
 	if err := conf.Read(); err != nil {
 		slog.Error("failed to read config", "error", err)

cmd/simulator/main.go

@@ -13,7 +13,6 @@ import (
 	"github.com/controlplaneio/simulator/v2/internal/cli"
 	"github.com/controlplaneio/simulator/v2/internal/config"
 	"github.com/controlplaneio/simulator/v2/internal/docker"
-	"github.com/controlplaneio/simulator/v2/internal/logging"
 )
 
 const (
@@ -31,8 +30,6 @@ var (
 )
 
 func main() {
-	logging.Configure()
-
 	conf := config.Config{}
 	if err := conf.Read(); err != nil {
 		slog.Error("failed to read config", "error", err)

docs/cli.md

@@ -60,3 +60,11 @@ bucket: <your-s3-bucket>
 container:
   image: controlplane/simulator:latest
 ```
+
+## Log level
+
+The default log level is set to `error` by default.
+
+It can be changed using the `--log-level` flag or by setting
+`SIMULATOR_LOG_LEVEL` environment variable to one of
+error, warn, info or debug.

internal/cli/simulator.go

@@ -1,9 +1,17 @@
 package cli
 
 import (
+	"os"
+
+	"github.com/controlplaneio/simulator/v2/internal/logging"
 	"github.com/spf13/cobra"
 )
 
+const (
+	logLevelEnv     = "SIMULATOR_LOG_LEVEL"
+	logLevelDefault = "error"
+)
+
 type SimulatorCmdOptions func(command *cobra.Command)
 
 func NewSimulatorCmd(opts ...SimulatorCmdOptions) *cobra.Command {
@@ -12,9 +20,26 @@ func NewSimulatorCmd(opts ...SimulatorCmdOptions) *cobra.Command {
 		Short: "Simulator CLI",
 	}
 
+	simulator.PersistentFlags().String("log-level", logLevel(), "Log level (error, warn, info, debug)")
+
+	simulator.PersistentPreRun = func(cmd *cobra.Command, _ []string) {
+		logLevel, err := cmd.Flags().GetString("log-level")
+		cobra.CheckErr(err)
+
+		err = logging.Configure(logLevel)
+		cobra.CheckErr(err)
+	}
+
 	for _, opt := range opts {
 		opt(simulator)
 	}
 
 	return simulator
 }
+
+func logLevel() string {
+	if l := os.Getenv(logLevelEnv); len(l) > 0 {
+		return l
+	}
+	return logLevelDefault
+}

internal/logging/factory.go

@@ -1,16 +1,34 @@
 package logging
 
 import (
+	"fmt"
 	"log/slog"
 	"os"
 )
 
-func Configure() {
+func Configure(level string) error {
+	var leveler slog.Leveler
+
+	switch level {
+	case "error":
+		leveler = slog.LevelError
+	case "warn":
+		leveler = slog.LevelWarn
+	case "info":
+		leveler = slog.LevelInfo
+	case "debug":
+		leveler = slog.LevelDebug
+	default:
+		return fmt.Errorf("unsupported log level: " + level)
+	}
+
 	handlerOptions := &slog.HandlerOptions{
 		AddSource: true,
-		Level:     slog.LevelError,
+		Level:     leveler,
 	}
 
 	logger := slog.New(slog.NewTextHandler(os.Stdout, handlerOptions))
 	slog.SetDefault(logger)
+
+	return nil
 }