feat: Add log level option, default to json prod log level (#35)

* feat: Add log level option, default to json prod log level

* Update suite_test.go

* Update manager.yaml

* Update README.md

README.md

@@ -32,6 +32,17 @@ Key features:
     - It will default to `15m` if not set
 - Optionally, you can enable rolling upgrade to deployments in the same namespace as the `GithubApp` that match any of the labels you define in `spec.rolloutDeployment.labels`
   - This is useful where pods need to be recreated to pickup the new secret data.
+- By default the logs are json formatted and log level is set to info and error, you can set `DEBUG_LOG` to `true` in the manager deployment environment variable for debug level logs.
+- The CRD has additional data printed with `kubectl get`:
+  - APP ID
+  - INSTALL ID
+  - EXPIRES AT
+  - ERROR
+- Events are recorded for:
+  - Any error on reconcile for a GithubApp
+  - Creation of an access token secret
+  - Updating an access token secret
+  - Updating a deployment for rolling upgrade
 
 ## Example creating a secret to hold a GitHub App private key
 - Get your GithubApp private key and encode to base64

cmd/main.go

@@ -20,6 +20,7 @@ import (
 	"crypto/tls"
 	"flag"
 	"os"
+	"strconv"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
 	// to ensure that exec-entrypoint and run can make use of them.
@@ -66,8 +67,14 @@ func main() {
 		"If set the metrics endpoint is served securely")
 	flag.BoolVar(&enableHTTP2, "enable-http2", false,
 		"If set, HTTP/2 will be enabled for the metrics and webhook servers")
+	// Read DEBUG_LOG from env var
+	debugLog, logVarErr := strconv.ParseBool(os.Getenv("DEBUG_LOG"))
+	if logVarErr != nil {
+	    // Default to false
+	    debugLog = false
+	}
 	opts := zap.Options{
-		Development: true,
+		Development: debugLog,
 	}
 	opts.BindFlags(flag.CommandLine)
 	flag.Parse()

config/manager/manager.yaml

@@ -104,5 +104,7 @@ spec:
             value: "5m"
           - name: EXPIRY_THRESHOLD
             value: "15m"
+          - name: DEBUG_LOG
+            value: false
       serviceAccountName: controller-manager
       terminationGracePeriodSeconds: 10

internal/controller/suite_test.go

@@ -80,6 +80,8 @@ var _ = BeforeSuite(func() {
 	Expect(osEnvErr).NotTo(HaveOccurred())
 	osEnvErr = os.Setenv("EXPIRY_THRESHOLD", "15m")
 	Expect(osEnvErr).NotTo(HaveOccurred())
+	osEnvErr = os.Setenv("DEBUG_LOG", "true")
+	Expect(osEnvErr).NotTo(HaveOccurred())
 
 	var err error
 	// cfg is defined in this file globally.