Merge pull request #642 from Kuadrant/log_level_env_var

fix: wrapped zap log level and mode with custom flags.

Author: maksymvavilov

CLAUDE.md

@@ -245,7 +245,7 @@ Follow these guidelines when working with logs:
 - `logger.Error()` - Errors not returned in reconciliation result (one error message only)
 - `logger.V(1).Info()` - Debug logs (every change/event/update)
 
-Use `--zap-devel` flag to enable debug level logs.
+Use `--log-mode=development` flag to enable debug level logs.
 
 Common log metadata:
 - `DNSRecord` - Name/namespace of DNSRecord being reconciled

Makefile

@@ -290,7 +290,7 @@ build: manifests generate fmt vet ## Build manager binary.
 RUN_METRICS_ADDR=":8080"
 RUN_HEALTH_ADDR=":8081"
 RUN_DELEGATION_ROLE="primary"
-DEFAULT_RUN_FLAGS ?= --zap-devel --provider inmemory,aws,google,azure,coredns,endpoint --delegation-role=${RUN_DELEGATION_ROLE} --metrics-bind-address=${RUN_METRICS_ADDR} --health-probe-bind-address=${RUN_HEALTH_ADDR}
+DEFAULT_RUN_FLAGS ?= --log-mode=development --provider inmemory,aws,google,azure,coredns,endpoint --delegation-role=${RUN_DELEGATION_ROLE} --metrics-bind-address=${RUN_METRICS_ADDR} --health-probe-bind-address=${RUN_HEALTH_ADDR}
 RUN_FLAGS ?= $(DEFAULT_RUN_FLAGS)
 
 .PHONY: run
@@ -310,7 +310,7 @@ run-secondary: ## Run a controller from your host with the secondary delegation
 run-with-probes: GIT_SHA=$(shell git rev-parse HEAD || echo "unknown")
 run-with-probes: DIRTY=$(shell hack/check-git-dirty.sh || echo "unknown")
 run-with-probes: manifests generate fmt vet ## Run a controller from your host.
-	go run -ldflags "-X main.version=v${VERSION} -X main.gitSHA=${GIT_SHA} -X main.dirty=${DIRTY}" --race  ./cmd/main.go --zap-devel --provider inmemory,aws,google,azure
+	go run -ldflags "-X main.version=v${VERSION} -X main.gitSHA=${GIT_SHA} -X main.dirty=${DIRTY}" --race  ./cmd/main.go --log-mode=development --provider inmemory,aws,google,azure
 
 # If you wish built the manager image targeting other platforms you can use the --platform flag.
 # (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.

README.md

@@ -141,7 +141,15 @@ Logs are following the general guidelines:
 - `logger.Error()` describe only those errors that are not returned in the result of the reconciliation. If error is occurred there should be only one error message. 
 - `logger.V(1).Info()` debug level logs to give information about every change or event caused by the resource as well as every update of the resource.
 
-The `--zap-devel` argument will enable debug level logs for the output. Otherwise, all `V()` logs are ignored.
+There are two flags to control logging output 
+- `--log-mode=[development|<any-other-value>]` will enable debug level logs for the output. 
+    The debug mode is the most verbose.
+- `--log-level` controls the level of displayed logs. Defaults to the most verbose in the `development` mode. 
+    In any other modes it can take numerical values form `-1` (Debug level) to `4` (Nothing). 
+    It is possible to specify other values, but hey will have no effect (e.g. `4` will do the same as `128`) 
+
+You can find more [here](https://pkg.go.dev/github.com/go-logr/zapr#section-readme).
+
 
 ### Common metadata 
 Not exhaustive list of metadata for DNSRecord controller:

cmd/main.go

@@ -27,14 +27,16 @@ import (
 	"strings"
 	"time"
 
+	"go.uber.org/zap/zapcore"
+
 	"k8s.io/apimachinery/pkg/util/runtime"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/kubernetes/scheme"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	zap "sigs.k8s.io/controller-runtime/pkg/log/zap"
 	"sigs.k8s.io/controller-runtime/pkg/metrics"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
@@ -78,6 +80,8 @@ var (
 	watchNamespaces        string
 	delegationRole         string
 	group                  types.Group
+	logMode                string
+	logLevel               string
 
 	// represents booth flag and envar key
 	metricsAddrKey            = variableKey("metrics-bind-address")
@@ -94,6 +98,8 @@ var (
 	watchNamespacesKey        = variableKey("watch-namespaces")
 	delegationRoleKey         = variableKey("delegation-role")
 	groupKey                  = variableKey("group")
+	logModeKey                = variableKey("log-mode")
+	logLevelKey               = variableKey("log-level")
 )
 
 const (
@@ -103,6 +109,9 @@ const (
 
 	DefaultClusterSecretNamespace = "dns-operator-system"
 	DefaultClusterSecretLabel     = "kuadrant.io/multicluster-kubeconfig"
+
+	DefaultLogLevel = zapcore.InfoLevel
+	DefaultLogMode  = "debug"
 )
 
 func init() {
@@ -137,16 +146,16 @@ func main() {
 	flag.StringVar(&clusterSecretNamespace, clusterSecretNamespaceKey.Flag(), DefaultClusterSecretNamespace, "The Namespace to look for cluster secrets.")
 	flag.StringVar(&clusterSecretLabel, clusterSecretLabelKey.Flag(), DefaultClusterSecretLabel, "The label that identifies a Secret resource as a cluster secret.")
 	flag.StringVar(&watchNamespaces, watchNamespacesKey.Flag(), "", "Comma separated list of default namespaces.")
+	flag.StringVar(&logLevel, logLevelKey.Flag(), DefaultLogLevel.String(), "Log level")
+	flag.StringVar(&logMode, logModeKey.Flag(), DefaultLogMode, "Log mode")
 
 	flag.Var(newDelegationRoleValue(controller.DelegationRolePrimary, &delegationRole), delegationRoleKey.Flag(), "The delegation role for this controller. Must be one of 'primary'(default), or 'secondary'")
 
-	flag.Var(&group, groupKey.Flag(), "Set Group for dns-operater")
+	flag.Var(&group, groupKey.Flag(), "Set Group for dns-operator")
 
-	opts := zap.Options{}
-	opts.BindFlags(flag.CommandLine)
 	flag.Parse()
 
-	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
+	ctrl.SetLogger(zap.New(withLogLevel(logLevel), withLogMode(logMode)))
 
 	printControllerMetaInfo()
 	overrideControllerFlags()
@@ -392,6 +401,12 @@ func overrideControllerFlags() {
 				os.Exit(1)
 			}
 			setupLog.Info(fmt.Sprintf("overriding %s flag with \"%s\" value", groupKey.Flag(), v))
+		case logModeKey.Envar():
+			logMode = v
+			setupLog.Info(fmt.Sprintf("overriding %s flag with \"%s\" value", logModeKey.Flag(), v))
+		case logLevelKey.Envar():
+			logLevel = v
+			setupLog.Info(fmt.Sprintf("overriding %s flag with \"%s\" value", logLevelKey.Flag(), v))
 		}
 	}
 }
@@ -448,3 +463,21 @@ func newDelegationRoleValue(val string, p *string) *delegationRoleValue {
 	*p = val
 	return (*delegationRoleValue)(p)
 }
+
+func withLogLevel(logLevel string) func(*zap.Options) {
+	lvl, err := zapcore.ParseLevel(logLevel)
+	if err != nil {
+		// If unable to parse the log level, set default
+		lvl = DefaultLogLevel
+	}
+
+	return func(options *zap.Options) {
+		options.Level = lvl
+	}
+}
+
+func withLogMode(logMode string) func(*zap.Options) {
+	return func(options *zap.Options) {
+		options.Development = logMode == "development"
+	}
+}

config/deploy/local/kustomization.yaml

@@ -13,7 +13,7 @@ patches:
         value: --provider=aws,google,inmemory,azure
       - op: add
         path: /spec/template/spec/containers/0/args/-
-        value: --zap-log-level=debug
+        value: --log-level=debug
     target:
       kind: Deployment
   - path: manager_config_patch.yaml

config/deploy/local/manager_config_patch.yaml

@@ -13,4 +13,4 @@ spec:
             - --metrics-bind-address=:8080
             - --leader-elect
             - --provider=aws,google,inmemory,azure,coredns,endpoint
-            - --zap-log-level=debug
+            - --log-level=debug

test/scale/kubeburner-object-templates/dns-operator/dns-operator-deployment.yaml

@@ -21,7 +21,7 @@ spec:
         - --leader-elect
         - --metrics-bind-address=:8080
         - --provider=aws,google,inmemory,azure
-        - --zap-log-level=debug
+        - --log-level=debug
         command:
         - /manager
         env:

test/scale/kubeburner-object-templates/dns-operator/kustomization.yaml

@@ -23,6 +23,6 @@ patches:
         value: --provider=aws,google,inmemory,azure
       - op: add
         path: /spec/template/spec/containers/0/args/-
-        value: --zap-log-level=debug
+        value: --log-level=debug
     target:
       kind: Deployment