feat: added the logging feature to documentation

Signed-off-by: Mihir Mittal <105881639+mihirm21@users.noreply.github.com>
open-feature · Jan 26, 2023 · 944b2bf · 944b2bf
1 parent 970e546
commit 944b2bf
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/cmd/start.go b/cmd/start.go
@@ -24,7 +24,7 @@ const (
 	bearerTokenFlagName    = "bearer-token"
 	corsFlagName           = "cors-origin"
 	syncProviderFlagName   = "sync-provider"
-	prettyLogFlagName      = "log-format"
+	logFormatFlagName      = "log-format"
 )
 
 func init() {
@@ -56,7 +56,7 @@ func init() {
 	flags.StringP(
 		syncProviderFlagName, "y", "", "DEPRECATED: Set a sync provider e.g. filepath or remote",
 	)
-	flags.StringP(prettyLogFlagName, "z", "console", "Set the logging format, e.g. console or json ")
+	flags.StringP(logFormatFlagName, "z", "console", "Set the logging format, e.g. console or json ")
 
 	_ = viper.BindPFlag(portFlagName, flags.Lookup(portFlagName))
 	_ = viper.BindPFlag(metricsPortFlagName, flags.Lookup(metricsPortFlagName))
@@ -69,7 +69,7 @@ func init() {
 	_ = viper.BindPFlag(bearerTokenFlagName, flags.Lookup(bearerTokenFlagName))
 	_ = viper.BindPFlag(corsFlagName, flags.Lookup(corsFlagName))
 	_ = viper.BindPFlag(syncProviderFlagName, flags.Lookup(syncProviderFlagName))
-	_ = viper.BindPFlag(prettyLogFlagName, flags.Lookup(prettyLogFlagName))
+	_ = viper.BindPFlag(logFormatFlagName, flags.Lookup(logFormatFlagName))
 }
 
 // startCmd represents the start command
@@ -86,7 +86,7 @@ var startCmd = &cobra.Command{
 		} else {
 			level = zapcore.InfoLevel
 		}
-		l, err := logger.NewZapLogger(level, viper.GetString(prettyLogFlagName))
+		l, err := logger.NewZapLogger(level, viper.GetString(logFormatFlagName))
 		if err != nil {
 			log.Fatalf("can't initialize zap logger: %v", err)
 		}

diff --git a/docs/configuration/flagd_start.md b/docs/configuration/flagd_start.md
@@ -13,6 +13,7 @@ flagd start [flags]
   -C, --cors-origin strings                 CORS allowed origins, * will allow all origins
   -e, --evaluator string                    DEPRECATED: Set an evaluator e.g. json, yaml/yml.Please note that yaml/yml and json evaluations work the same (yaml/yml files are converted to json internally) (default "json")
   -h, --help                                help for start
+  -z, --log-format string                   Set the logging format, e.g. console or json  (default "console")
   -m, --metrics-port int32                  Port to serve metrics on (default 8014)
   -p, --port int32                          Port to listen on (default 8013)
   -c, --server-cert-path string             Server side tls certificate path