allow to customize the log level

The old log-verbose flag is not appropriate anymore. You should now use the log-level flag to set your preferred log level. The default level is "debug" as before, you can also set "info", "warn", "error" Signed-off-by: Nicola Murino <nicola.murino@gmail.com>
2024-04-21 12:32:38 +00:00 · 2022-07-13 10:40:24 +02:00
parent 8fc4971df1
commit e0ce2e2e8a
16 changed files with 95 additions and 57 deletions
@@ -30,7 +30,7 @@ Please take a look at the usage below to customize the startup options`,
 				LogMaxBackups: logMaxBackups,
 				LogMaxAge:     logMaxAge,
 				LogCompress:   logCompress,
-				LogVerbose:    logVerbose,
+				LogLevel:      logLevel,
 				LogUTCTime:    logUTCTime,
 				Shutdown:      make(chan bool),
 			}
@@ -85,8 +85,9 @@ func getCustomServeFlags() []string {
 		result = append(result, "--"+logMaxAgeFlag)
 		result = append(result, strconv.Itoa(logMaxAge))
 	}
-	if logVerbose != defaultLogVerbose {
-		result = append(result, "--"+logVerboseFlag+"=false")
+	if logLevel != defaultLogLevel {
+		result = append(result, "--"+logLevelFlag)
+		result = append(result, logLevel)
 	}
 	if logUTCTime != defaultLogUTCTime {
 		result = append(result, "--"+logUTCTimeFlag+"=true")
@@ -31,7 +31,7 @@ var (
 	portablePassword                   string
 	portableStartDir                   string
 	portableLogFile                    string
-	portableLogVerbose                 bool
+	portableLogLevel                   string
 	portableLogUTCTime                 bool
 	portablePublicKeys                 []string
 	portablePermissions                []string
@@ -163,7 +163,7 @@ Please take a look at the usage below to customize the serving parameters`,
 				LogMaxBackups: defaultLogMaxBackup,
 				LogMaxAge:     defaultLogMaxAge,
 				LogCompress:   defaultLogCompress,
-				LogVerbose:    portableLogVerbose,
+				LogLevel:      portableLogLevel,
 				LogUTCTime:    portableLogUTCTime,
 				Shutdown:      make(chan bool),
 				PortableMode:  1,
@@ -281,7 +281,11 @@ value`)
 	portableCmd.Flags().StringVarP(&portablePassword, "password", "p", "", `Leave empty to use an auto generated
 value`)
 	portableCmd.Flags().StringVarP(&portableLogFile, logFilePathFlag, "l", "", "Leave empty to disable logging")
-	portableCmd.Flags().BoolVarP(&portableLogVerbose, logVerboseFlag, "v", false, "Enable verbose logs")
+	portableCmd.Flags().StringVar(&portableLogLevel, logLevelFlag, defaultLogLevel, `Set the log level.
+Supported values:
+
+debug, info, warn, error.
+`)
 	portableCmd.Flags().BoolVar(&portableLogUTCTime, logUTCTimeFlag, false, "Use UTC time for logging")
 	portableCmd.Flags().StringSliceVarP(&portablePublicKeys, "public-key", "k", []string{}, "")
 	portableCmd.Flags().StringSliceVarP(&portablePermissions, "permissions", "g", []string{"list", "download"},
@@ -26,8 +26,8 @@ const (
 	logMaxAgeKey             = "log_max_age"
 	logCompressFlag          = "log-compress"
 	logCompressKey           = "log_compress"
-	logVerboseFlag           = "log-verbose"
-	logVerboseKey            = "log_verbose"
+	logLevelFlag             = "log-level"
+	logLevelKey              = "log_level"
 	logUTCTimeFlag           = "log-utc-time"
 	logUTCTimeKey            = "log_utc_time"
 	loadDataFromFlag         = "loaddata-from"
@@ -45,7 +45,7 @@ const (
 	defaultLogMaxBackup      = 5
 	defaultLogMaxAge         = 28
 	defaultLogCompress       = false
-	defaultLogVerbose        = true
+	defaultLogLevel          = "debug"
 	defaultLogUTCTime        = false
 	defaultLoadDataFrom      = ""
 	defaultLoadDataMode      = 1
@@ -61,7 +61,7 @@ var (
 	logMaxBackups     int
 	logMaxAge         int
 	logCompress       bool
-	logVerbose        bool
+	logLevel          string
 	logUTCTime        bool
 	loadDataFrom      string
 	loadDataMode      int
@@ -215,13 +215,17 @@ It is unused if log-file-path is empty.
 `)
 	viper.BindPFlag(logCompressKey, cmd.Flags().Lookup(logCompressFlag)) //nolint:errcheck

-	viper.SetDefault(logVerboseKey, defaultLogVerbose)
-	viper.BindEnv(logVerboseKey, "SFTPGO_LOG_VERBOSE") //nolint:errcheck
-	cmd.Flags().BoolVarP(&logVerbose, logVerboseFlag, "v", viper.GetBool(logVerboseKey),
-		`Enable verbose logs. This flag can be set
-using SFTPGO_LOG_VERBOSE env var too.
+	viper.SetDefault(logLevelKey, defaultLogLevel)
+	viper.BindEnv(logLevelKey, "SFTPGO_LOG_LEVEL") //nolint:errcheck
+	cmd.Flags().StringVar(&logLevel, logLevelFlag, viper.GetString(logLevelKey),
+		`Set the log level. Supported values:
+
+debug, info, warn, error.
+
+This flag can be set
+using SFTPGO_LOG_LEVEL env var too.
 `)
-	viper.BindPFlag(logVerboseKey, cmd.Flags().Lookup(logVerboseFlag)) //nolint:errcheck
+	viper.BindPFlag(logLevelKey, cmd.Flags().Lookup(logLevelFlag)) //nolint:errcheck

 	viper.SetDefault(logUTCTimeKey, defaultLogUTCTime)
 	viper.BindEnv(logUTCTimeKey, "SFTPGO_LOG_UTC_TIME") //nolint:errcheck
@@ -28,7 +28,7 @@ Please take a look at the usage below to customize the startup options`,
 				LogMaxBackups:     logMaxBackups,
 				LogMaxAge:         logMaxAge,
 				LogCompress:       logCompress,
-				LogVerbose:        logVerbose,
+				LogLevel:          logLevel,
 				LogUTCTime:        logUTCTime,
 				LoadDataFrom:      loadDataFrom,
 				LoadDataMode:      loadDataMode,
@@ -28,7 +28,7 @@ var (
 				LogMaxBackups: logMaxBackups,
 				LogMaxAge:     logMaxAge,
 				LogCompress:   logCompress,
-				LogVerbose:    logVerbose,
+				LogLevel:      logLevel,
 				LogUTCTime:    logUTCTime,
 				Shutdown:      make(chan bool),
 			}
@@ -40,15 +40,22 @@ Command-line flags should be specified in the Subsystem declaration.
 		Run: func(cmd *cobra.Command, args []string) {
 			logSender := "startsubsys"
 			connectionID := xid.New().String()
-			logLevel := zerolog.DebugLevel
-			if !logVerbose {
-				logLevel = zerolog.InfoLevel
+			var zeroLogLevel zerolog.Level
+			switch logLevel {
+			case "info":
+				zeroLogLevel = zerolog.InfoLevel
+			case "warn":
+				zeroLogLevel = zerolog.WarnLevel
+			case "error":
+				zeroLogLevel = zerolog.ErrorLevel
+			default:
+				zeroLogLevel = zerolog.DebugLevel
 			}
 			logger.SetLogTime(logUTCTime)
 			if logJournalD {
-				logger.InitJournalDLogger(logLevel)
+				logger.InitJournalDLogger(zeroLogLevel)
 			} else {
-				logger.InitStdErrLogger(logLevel)
+				logger.InitStdErrLogger(zeroLogLevel)
 			}
 			osUser, err := user.Current()
 			if err != nil {
@@ -84,7 +91,7 @@ Command-line flags should be specified in the Subsystem declaration.
 				logger.Error(logSender, "", "unable to initialize MFA: %v", err)
 				os.Exit(1)
 			}
-			if err := plugin.Initialize(config.GetPluginsConfig(), logVerbose); err != nil {
+			if err := plugin.Initialize(config.GetPluginsConfig(), logLevel); err != nil {
 				logger.Error(logSender, connectionID, "unable to initialize plugin system: %v", err)
 				os.Exit(1)
 			}
@@ -182,13 +189,17 @@ error`)

 	addConfigFlags(subsystemCmd)

-	viper.SetDefault(logVerboseKey, defaultLogVerbose)
-	viper.BindEnv(logVerboseKey, "SFTPGO_LOG_VERBOSE") //nolint:errcheck
-	subsystemCmd.Flags().BoolVarP(&logVerbose, logVerboseFlag, "v", viper.GetBool(logVerboseKey),
-		`Enable verbose logs. This flag can be set
-using SFTPGO_LOG_VERBOSE env var too.
+	viper.SetDefault(logLevelKey, defaultLogLevel)
+	viper.BindEnv(logLevelKey, "SFTPGO_LOG_LEVEL") //nolint:errcheck
+	subsystemCmd.Flags().StringVar(&logLevel, logLevelFlag, viper.GetString(logLevelKey),
+		`Set the log level. Supported values:
+
+debug, info, warn, error.
+
+This flag can be set
+using SFTPGO_LOG_LEVEL env var too.
 `)
-	viper.BindPFlag(logVerboseKey, subsystemCmd.Flags().Lookup(logVerboseFlag)) //nolint:errcheck
+	viper.BindPFlag(logLevelKey, subsystemCmd.Flags().Lookup(logLevelFlag)) //nolint:errcheck

 	viper.SetDefault(logUTCTimeKey, defaultLogUTCTime)
 	viper.BindEnv(logUTCTimeKey, "SFTPGO_LOG_UTC_TIME") //nolint:errcheck