adding ability to specify the default log level for the application (#649)

Author: husobee

utils/context/getters.go

@@ -36,6 +36,20 @@ func GetDurationFromContext(ctx context.Context, key CTXKey) (time.Duration, err
 	return time.Duration(0), ErrValueWrongType
 }
 
+//GetLogLevelFromContext - given a CTXKey return the duration value from the context if it exists
+func GetLogLevelFromContext(ctx context.Context, key CTXKey) (zerolog.Level, error) {
+	v := ctx.Value(key)
+	if v == nil {
+		// value not on context
+		return zerolog.InfoLevel, ErrNotInContext
+	}
+	if l, ok := v.(zerolog.Level); ok {
+		return l, nil
+	}
+	// value not a log level
+	return zerolog.InfoLevel, ErrValueWrongType
+}
+
 //GetLogger - return the logger value from the context if it exists
 func GetLogger(ctx context.Context) (*zerolog.Logger, error) {
 	// get the logger from the context, if the logger is disabled

utils/context/keys.go

@@ -53,6 +53,8 @@ const (
 	BraveTransferPromotionIDCTXKey CTXKey = "brave_transfer_promotion_id"
 	// WalletOnPlatformPriorToCTXKey - context key for the build time of code
 	WalletOnPlatformPriorToCTXKey CTXKey = "wallet_on_platform_prior_to"
+	// LogLevelCTXKey - context key for application logging level
+	LogLevelCTXKey CTXKey = "log_level"
 )
 
 var (

utils/logging/logging.go

@@ -31,15 +31,25 @@ func init() {
 	prometheus.MustRegister(droppedLogTotal)
 }
 
+// SetupLoggerWithLevel - helper to setup a logger and associate with context with a given log level
+func SetupLoggerWithLevel(ctx context.Context, level zerolog.Level) (context.Context, *zerolog.Logger) {
+	// setup context with log level passed in
+	ctx = context.WithValue(ctx, appctx.LogLevelCTXKey, level)
+	// call SetupLogger
+	return SetupLogger(ctx)
+}
+
 // SetupLogger - helper to setup a logger and associate with context
 func SetupLogger(ctx context.Context) (context.Context, *zerolog.Logger) {
-	var (
-		env, err = appctx.GetStringFromContext(ctx, appctx.EnvironmentCTXKey)
-	)
+	env, err := appctx.GetStringFromContext(ctx, appctx.EnvironmentCTXKey)
 	if err != nil {
 		// if not in context, default to local
 		env = "local"
 	}
+
+	// defaults to info level
+	level, _ := appctx.GetLogLevelFromContext(ctx, appctx.LogLevelCTXKey)
+
 	var output io.Writer
 	if env != "local" {
 		// this log writer uses a ring buffer and drops messages that cannot be processed
@@ -71,10 +81,11 @@ func SetupLogger(ctx context.Context) (context.Context, *zerolog.Logger) {
 		}
 	}
 
-	if !debug {
-		// if not debug, set log level to info
-		l = l.Level(zerolog.InfoLevel)
-	} else {
+	// set the log level
+	l = l.Level(level)
+
+	// debug override
+	if debug {
 		l = l.Level(zerolog.DebugLevel)
 	}