From 63e3cd15fb68b22593deed0425014696abc79a73 Mon Sep 17 00:00:00 2001 From: jillianwilson Date: Thu, 3 Aug 2023 14:31:39 -0300 Subject: [PATCH] Noving log levels to variables --- controllers/deployment_controller.go | 5 +++-- controllers/onepassworditem_controller.go | 3 ++- pkg/logs/log_levels.go | 13 +++++++++++++ pkg/onepassword/secret_update_handler.go | 7 ++++--- pkg/utils/k8sutil.go | 3 ++- 5 files changed, 24 insertions(+), 7 deletions(-) create mode 100644 pkg/logs/log_levels.go diff --git a/controllers/deployment_controller.go b/controllers/deployment_controller.go index e329ff0..b4e0869 100644 --- a/controllers/deployment_controller.go +++ b/controllers/deployment_controller.go @@ -34,6 +34,7 @@ import ( "github.com/1Password/connect-sdk-go/connect" kubeSecrets "github.com/1Password/onepassword-operator/pkg/kubernetessecrets" + "github.com/1Password/onepassword-operator/pkg/logs" op "github.com/1Password/onepassword-operator/pkg/onepassword" "github.com/1Password/onepassword-operator/pkg/utils" @@ -73,7 +74,7 @@ type DeploymentReconciler struct { // - https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile func (r *DeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { reqLogger := logDeployment.WithValues("Request.Namespace", req.Namespace, "Request.Name", req.Name) - reqLogger.V(1).Info("Reconciling Deployment") + reqLogger.V(int(logs.DebugLevel)).Info("Reconciling Deployment") deployment := &appsv1.Deployment{} err := r.Get(context.Background(), req.NamespacedName, deployment) @@ -86,7 +87,7 @@ func (r *DeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request) annotations, annotationsFound := op.GetAnnotationsForDeployment(deployment, r.OpAnnotationRegExp) if !annotationsFound { - reqLogger.V(1).Info("No 1Password Annotations found") + reqLogger.V(int(logs.DebugLevel)).Info("No 1Password Annotations found") return ctrl.Result{}, nil } diff --git a/controllers/onepassworditem_controller.go b/controllers/onepassworditem_controller.go index b552bad..51afefa 100644 --- a/controllers/onepassworditem_controller.go +++ b/controllers/onepassworditem_controller.go @@ -32,6 +32,7 @@ import ( onepasswordv1 "github.com/1Password/onepassword-operator/api/v1" kubeSecrets "github.com/1Password/onepassword-operator/pkg/kubernetessecrets" + "github.com/1Password/onepassword-operator/pkg/logs" op "github.com/1Password/onepassword-operator/pkg/onepassword" "github.com/1Password/onepassword-operator/pkg/utils" @@ -78,7 +79,7 @@ type OnePasswordItemReconciler struct { // - https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile func (r *OnePasswordItemReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { reqLogger := logOnePasswordItem.WithValues("Request.Namespace", req.Namespace, "Request.Name", req.Name) - reqLogger.V(1).Info("Reconciling OnePasswordItem") + reqLogger.V(int(logs.DebugLevel)).Info("Reconciling OnePasswordItem") onepassworditem := &onepasswordv1.OnePasswordItem{} err := r.Get(context.Background(), req.NamespacedName, onepassworditem) diff --git a/pkg/logs/log_levels.go b/pkg/logs/log_levels.go new file mode 100644 index 0000000..9e72789 --- /dev/null +++ b/pkg/logs/log_levels.go @@ -0,0 +1,13 @@ +package logs + +// A Level is a logging priority. Lower levels are more important. +// All levels have been multipled by -1 to ensure compatibilty +// between zapcore and logr +type Level int + +const ( + ErrorLevel Level = iota - 2 + WarnLevel + InfoLevel + DebugLevel +) diff --git a/pkg/onepassword/secret_update_handler.go b/pkg/onepassword/secret_update_handler.go index baa3d8c..3b65e9e 100644 --- a/pkg/onepassword/secret_update_handler.go +++ b/pkg/onepassword/secret_update_handler.go @@ -7,6 +7,7 @@ import ( onepasswordv1 "github.com/1Password/onepassword-operator/api/v1" kubeSecrets "github.com/1Password/onepassword-operator/pkg/kubernetessecrets" + "github.com/1Password/onepassword-operator/pkg/logs" "github.com/1Password/onepassword-operator/pkg/utils" "github.com/1Password/connect-sdk-go/connect" @@ -82,7 +83,7 @@ func (h *SecretUpdateHandler) restartDeploymentsWithUpdatedSecrets(updatedSecret } } - log.V(1).Info(fmt.Sprintf("Deployment %q at namespace %q is up to date", deployment.GetName(), deployment.Namespace)) + log.V(int(logs.DebugLevel)).Info(fmt.Sprintf("Deployment %q at namespace %q is up to date", deployment.GetName(), deployment.Namespace)) } return nil @@ -131,7 +132,7 @@ func (h *SecretUpdateHandler) updateKubernetesSecrets() (map[string]map[string]* if currentVersion != itemVersion || secret.Annotations[ItemPathAnnotation] != itemPathString { if isItemLockedForForcedRestarts(item) { - log.V(1).Info(fmt.Sprintf("Secret '%v' has been updated in 1Password but is set to be ignored. Updates to an ignored secret will not trigger an update to a kubernetes secret or a rolling restart.", secret.GetName())) + log.V(int(logs.DebugLevel)).Info(fmt.Sprintf("Secret '%v' has been updated in 1Password but is set to be ignored. Updates to an ignored secret will not trigger an update to a kubernetes secret or a rolling restart.", secret.GetName())) secret.Annotations[VersionAnnotation] = itemVersion secret.Annotations[ItemPathAnnotation] = itemPathString if err := h.client.Update(context.Background(), &secret); err != nil { @@ -144,7 +145,7 @@ func (h *SecretUpdateHandler) updateKubernetesSecrets() (map[string]map[string]* secret.Annotations[VersionAnnotation] = itemVersion secret.Annotations[ItemPathAnnotation] = itemPathString secret.Data = kubeSecrets.BuildKubernetesSecretData(item.Fields, item.Files) - log.V(1).Info(fmt.Sprintf("New secret path: %v and version: %v", secret.Annotations[ItemPathAnnotation], secret.Annotations[VersionAnnotation])) + log.V(int(logs.DebugLevel)).Info(fmt.Sprintf("New secret path: %v and version: %v", secret.Annotations[ItemPathAnnotation], secret.Annotations[VersionAnnotation])) if err := h.client.Update(context.Background(), &secret); err != nil { log.Error(err, "failed to update secret %s to version %d: %s", secret.Name, itemVersion, err) continue diff --git a/pkg/utils/k8sutil.go b/pkg/utils/k8sutil.go index d9609a7..b2252ba 100644 --- a/pkg/utils/k8sutil.go +++ b/pkg/utils/k8sutil.go @@ -19,6 +19,7 @@ import ( "os" "strings" + "github.com/1Password/onepassword-operator/pkg/logs" logf "sigs.k8s.io/controller-runtime/pkg/log" ) @@ -54,7 +55,7 @@ func GetOperatorNamespace() (string, error) { return "", err } ns := strings.TrimSpace(string(nsBytes)) - log.V(1).Info("Found namespace", "Namespace", ns) + log.V(int(logs.DebugLevel)).Info("Found namespace", "Namespace", ns) return ns, nil }