feat: implementing klog structured logging #79
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,6 +28,8 @@ import ( | |
| "strings" | ||
| "time" | ||
|
|
||
| "k8s.io/klog/v2" | ||
|
|
||
| "golang.org/x/crypto/pbkdf2" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/api/meta" | ||
|
|
@@ -39,7 +41,6 @@ import ( | |
| ctrl "sigs.k8s.io/controller-runtime" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/event" | ||
| "sigs.k8s.io/controller-runtime/pkg/predicate" | ||
|
|
||
| secretsstorecsiv1 "sigs.k8s.io/secrets-store-csi-driver/apis/v1" | ||
|
|
@@ -107,13 +108,12 @@ type SecretSyncReconciler struct { | |
| //+kubebuilder:rbac:groups=secrets-store.csi.x-k8s.io,resources=secretproviderclasses,verbs=get;list;watch | ||
|
|
||
| func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { | ||
| klog.V(4).InfoS("Reconciling SecretSync", "namespace", req.Namespace, "name", req.Name) | ||
|
|
||
| // get the secret sync object | ||
| ss := &secretsyncv1alpha1.SecretSync{} | ||
| if err := r.Get(ctx, req.NamespacedName, ss); err != nil { | ||
| klog.ErrorS(err, "Unable to fetch SecretSync") | ||
|
There was a problem hiding this comment. keep all log strings to start with lower case There was a problem hiding this comment. Are you sure? according to this: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#message-style-guidelines we should start with a capital letter |
||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
|
|
@@ -130,7 +130,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
| secretName := strings.TrimSpace(ss.Name) | ||
| secretObj := ss.Spec.SecretObject | ||
| if err := secretutil.ValidateSecretObject(secretName, secretObj); err != nil { | ||
| klog.ErrorS(err, "Failed to validate secret object", "secretName", secretName) | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonUserInputValidationFailed, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
@@ -143,7 +143,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
| // get the service account token | ||
| serviceAccountTokenAttrs, err := r.TokenClient.SecretProviderServiceAccountTokenAttrs(ss.Namespace, ss.Spec.ServiceAccountName, r.Audiences) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Failed to get service account token", "name", ss.Spec.ServiceAccountName) | ||
|
|
||
| conditionReason := ConditionReasonSecretPatchFailedUnknownError | ||
| if checkIfErrorMessageCanBeDisplayed(err.Error()) { | ||
|
|
@@ -158,7 +158,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
| // get the secret provider class object | ||
| spc := &secretsstorecsiv1.SecretProviderClass{} | ||
| if err := r.Get(ctx, client.ObjectKey{Name: ss.Spec.SecretProviderClassName, Namespace: req.Namespace}, spc); err != nil { | ||
| klog.ErrorS(err, "Failed to get secret provider class", "name", ss.Spec.SecretProviderClassName) | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonControllerSpcError, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
@@ -180,15 +180,15 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
|
|
||
| paramsJSON, err := json.Marshal(parameters) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Failed to marshal parameters", "parameters", parameters) | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonControllerInternalError, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| providerName := string(spc.Spec.Provider) | ||
| providerClient, err := r.ProviderClients.Get(ctx, providerName) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Failed to get provider client", "provider", providerName) | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonControllerSpcError, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
@@ -197,7 +197,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
| var secretsJSON []byte | ||
| secretsJSON, err = json.Marshal(secretRefData) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Failed to marshal secret") | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonControllerInternalError, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
@@ -206,23 +206,23 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
|
|
||
| objectVersions, files, err := provider.MountContent(ctx, providerClient, string(paramsJSON), string(secretsJSON), oldObjectVersions) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Failed to get secrets from provider", "provider", providerName) | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonFailedProviderError, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| secretType := secretutil.GetSecretType(strings.TrimSpace(secretObj.Type)) | ||
| var datamap map[string][]byte | ||
| if datamap, err = secretutil.GetSecretData(secretObj.Data, secretType, files); err != nil { | ||
| klog.ErrorS(err, "Failed to get secret data", "secretName", secretName) | ||
| r.updateStatusConditions(ctx, ss, ConditionTypeUnknown, conditionType, ConditionReasonUserInputValidationFailed, true) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| // Compute the hash of the secret | ||
| syncHash, err := r.computeSecretDataObjectHash(datamap, spc, ss) | ||
| if err != nil { | ||
| klog.ErrorS(err, "Failed to compute secret data object hash", "secretName", secretName) | ||
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
|
|
@@ -263,7 +263,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
|
|
||
| // Attempt to create or update the secret. | ||
| if err = r.serverSidePatchSecret(ctx, ss, secretName, req.Namespace, datamap, objectVersions, labels, annotations, secretType); err != nil { | ||
| klog.ErrorS(err, "Failed to patch secret", "secretName", secretName) | ||
|
|
||
| // Rollback to the previous hash and the previous last successful sync time. | ||
| ss.Status.SyncHash = prevSecretHash | ||
|
|
@@ -296,7 +296,7 @@ func (r *SecretSyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |
| return ctrl.Result{}, err | ||
| } | ||
|
|
||
| klog.V(4).InfoS("Status updated", "syncHash", syncHash, "lastSuccessfulSyncTime", ss.Status.LastSuccessfulSyncTime) | ||
| return ctrl.Result{}, nil | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wire up
mloghere too. Ref - https://github.com/kubernetes-sigs/secrets-store-csi-driver/blob/981b21afa7f331860252f7b061cebe6e52eb22d3/cmd/secrets-store-csi-driver/main.go#L96-L104