log: define OutputFormat type

thaJeztah · thaJeztah · commit dd127885feac · 2023-09-09T00:09:47.000+02:00
Strong-type the format. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit dd67240) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
diff --git a/cmd/containerd/command/main.go b/cmd/containerd/command/main.go
@@ -352,7 +352,7 @@ func setLogLevel(context *cli.Context, config *srvconfig.Config) error {
 }
 
 func setLogFormat(config *srvconfig.Config) error {
-	f := config.Debug.Format
+	f := log.OutputFormat(config.Debug.Format)
 	if f == "" {
 		f = log.TextFormat
 	}
diff --git a/log/context.go b/log/context.go
@@ -96,17 +96,20 @@ func GetLevel() Level {
 	return logrus.GetLevel()
 }
 
+// OutputFormat specifies a log output format.
+type OutputFormat string
+
 // Supported log output formats.
 const (
 	// TextFormat represents the text logging format.
-	TextFormat = "text"
+	TextFormat OutputFormat = "text"
 
 	// JSONFormat represents the JSON logging format.
-	JSONFormat = "json"
+	JSONFormat OutputFormat = "json"
 )
 
 // SetFormat sets the log output format ([TextFormat] or [JSONFormat]).
-func SetFormat(format string) error {
+func SetFormat(format OutputFormat) error {
 	switch format {
 	case TextFormat:
 		logrus.SetFormatter(&logrus.TextFormatter{

Original file line number	Diff line number	Diff line change
`@@ -352,7 +352,7 @@ func setLogLevel(context cli.Context, config srvconfig.Config) error {`
`352`	`352`	`}`
`353`	`353`
`354`	`354`	`func setLogFormat(config *srvconfig.Config) error {`
`355`		`- f := config.Debug.Format`
	`355`	`+ f := log.OutputFormat(config.Debug.Format)`
`356`	`356`	`if f == "" {`
`357`	`357`	`f = log.TextFormat`
`358`	`358`	`}`