Setup production logging

For production the log format is JSON, the timestamps format is ISO8601 and stack traces are logged when the level is set to debug.

Author: stefanprodan

config/manager/manager.yaml

@@ -22,18 +22,26 @@ spec:
       labels:
         control-plane: controller-manager
     spec:
+      terminationGracePeriodSeconds: 10
       containers:
-      - command:
-        - /manager
-        args:
-        - --enable-leader-election
+      - name: manager
         image: controller:latest
-        name: manager
+        ports:
+          - containerPort: 8080
+            name: http-prom
+        args:
+          - --enable-leader-election
+          - --log-level=debug
+          - --log-json
+        livenessProbe:
+          httpGet:
+            port: http-prom
+            path: /metrics
         resources:
           limits:
-            cpu: 100m
-            memory: 30Mi
+            cpu: 1000m
+            memory: 500Mi
           requests:
             cpu: 100m
-            memory: 20Mi
-      terminationGracePeriodSeconds: 10
+            memory: 32Mi
+

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/fluxcd/pkg v0.0.3
 	github.com/fluxcd/source-controller v0.0.2
 	github.com/go-logr/logr v0.1.0
+	go.uber.org/zap v1.10.0
 	k8s.io/apimachinery v0.18.4
 	k8s.io/client-go v0.18.4
 	sigs.k8s.io/controller-runtime v0.6.0

main.go

@@ -20,14 +20,16 @@ import (
 	"flag"
 	"os"
 
-	sourcev1 "github.com/fluxcd/source-controller/api/v1alpha1"
-
+	"github.com/go-logr/logr"
+	uzap "go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 	"k8s.io/apimachinery/pkg/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
+	sourcev1 "github.com/fluxcd/source-controller/api/v1alpha1"
 	"github.com/stefanprodan/source-watcher/controllers"
 	// +kubebuilder:scaffold:imports
 )
@@ -48,17 +50,19 @@ func main() {
 	var (
 		metricsAddr          string
 		enableLeaderElection bool
+		logLevel             string
 		logJSON              bool
 	)
 
 	flag.StringVar(&metricsAddr, "metrics-addr", ":8080", "The address the metric endpoint binds to.")
 	flag.BoolVar(&enableLeaderElection, "enable-leader-election", false,
 		"Enable leader election for controller manager. "+
 			"Enabling this will ensure there is only one active controller manager.")
+	flag.StringVar(&logLevel, "log-level", "info", "Set logging level. Can be debug, info or error.")
 	flag.BoolVar(&logJSON, "log-json", false, "Set logging to JSON format.")
 	flag.Parse()
 
-	ctrl.SetLogger(zap.New(zap.UseDevMode(!logJSON)))
+	ctrl.SetLogger(newLogger(logLevel, logJSON))
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
 		Scheme:             scheme,
@@ -89,3 +93,29 @@ func main() {
 		os.Exit(1)
 	}
 }
+
+// newLogger returns a logger configured for dev or production use.
+// For production the log format is JSON, the timestamps format is ISO8601
+// and stack traces are logged when the level is set to debug.
+func newLogger(level string, production bool) logr.Logger {
+	if !production {
+		return zap.New(zap.UseDevMode(true))
+	}
+
+	encCfg := uzap.NewProductionEncoderConfig()
+	encCfg.EncodeTime = zapcore.ISO8601TimeEncoder
+	encoder := zap.Encoder(zapcore.NewJSONEncoder(encCfg))
+
+	logLevel := zap.Level(zapcore.InfoLevel)
+	stacktraceLevel := zap.StacktraceLevel(zapcore.PanicLevel)
+
+	switch level {
+	case "debug":
+		logLevel = zap.Level(zapcore.DebugLevel)
+		stacktraceLevel = zap.StacktraceLevel(zapcore.ErrorLevel)
+	case "error":
+		logLevel = zap.Level(zapcore.ErrorLevel)
+	}
+
+	return zap.New(encoder, logLevel, stacktraceLevel)
+}