Skip to content

Commit 5b36752

Browse files
Madhu-1Madhu-1
committed
replace klog with controller runtime log
Replacing the klog wit controller runtime logger to have uniformity over the repo. fixes: #836 Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
1 parent 5ac5b17 commit 5b36752

15 files changed

Lines changed: 156 additions & 128 deletions

File tree

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ require (
1919
k8s.io/api v0.35.2
2020
k8s.io/apimachinery v0.35.2
2121
k8s.io/client-go v0.35.2
22-
k8s.io/klog/v2 v2.140.0
2322
k8s.io/mount-utils v0.35.2
2423
k8s.io/utils v0.0.0-20251002143259-bc988d571ff4
2524
sigs.k8s.io/controller-runtime v0.23.3
@@ -101,6 +100,7 @@ require (
101100
k8s.io/apiextensions-apiserver v0.35.0 // indirect
102101
k8s.io/apiserver v0.35.0 // indirect
103102
k8s.io/component-base v0.35.0 // indirect
103+
k8s.io/klog/v2 v2.130.1 // indirect
104104
k8s.io/kube-openapi v0.0.0-20250910181357-589584f1c912 // indirect
105105
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.31.2 // indirect
106106
sigs.k8s.io/json v0.0.0-20250730193827-2d320260d730 // indirect

‎go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,8 @@ k8s.io/client-go v0.35.2 h1:YUfPefdGJA4aljDdayAXkc98DnPkIetMl4PrKX97W9o=
249249
k8s.io/client-go v0.35.2/go.mod h1:4QqEwh4oQpeK8AaefZ0jwTFJw/9kIjdQi0jpKeYvz7g=
250250
k8s.io/component-base v0.35.0 h1:+yBrOhzri2S1BVqyVSvcM3PtPyx5GUxCK2tinZz1G94=
251251
k8s.io/component-base v0.35.0/go.mod h1:85SCX4UCa6SCFt6p3IKAPej7jSnF3L8EbfSyMZayJR0=
252-
k8s.io/klog/v2 v2.140.0 h1:Tf+J3AH7xnUzZyVVXhTgGhEKnFqye14aadWv7bzXdzc=
253-
k8s.io/klog/v2 v2.140.0/go.mod h1:o+/RWfJ6PwpnFn7OyAG3QnO47BFsymfEfrz6XyYSSp0=
252+
k8s.io/klog/v2 v2.130.1 h1:n9Xl7H1Xvksem4KFG4PYbdQCQxqc/tTUyrgXaOhHSzk=
253+
k8s.io/klog/v2 v2.130.1/go.mod h1:3Jpz1GvMt720eyJH1ckRHK1EDfpxISzJ7I9OYgaDtPE=
254254
k8s.io/kube-openapi v0.0.0-20250910181357-589584f1c912 h1:Y3gxNAuB0OBLImH611+UDZcmKS3g6CthxToOb37KgwE=
255255
k8s.io/kube-openapi v0.0.0-20250910181357-589584f1c912/go.mod h1:kdmbQkyfwUagLfXIad1y2TdrjPFWp2Q89B3qkRwf/pQ=
256256
k8s.io/mount-utils v0.35.2 h1:ltYDuCBnaLF4DaYAP7Fybj2irGshOrLmBfcT6XeaSZk=

‎internal/sidecar/service/encryptionkeyrotation.go‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929
"google.golang.org/grpc/status"
3030
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
3131
"k8s.io/client-go/kubernetes"
32-
"k8s.io/klog/v2"
32+
"sigs.k8s.io/controller-runtime/pkg/log"
3333
)
3434

3535
type EncryptionKeyRotationServer struct {
@@ -54,6 +54,7 @@ func (ekrs *EncryptionKeyRotationServer) RegisterService(server grpc.ServiceRegi
5454
func (ekrs *EncryptionKeyRotationServer) EncryptionKeyRotate(
5555
ctx context.Context, req *proto.EncryptionKeyRotateRequest,
5656
) (*proto.EncryptionKeyRotateResponse, error) {
57+
logger := log.FromContext(ctx)
5758
pvName := req.GetPvName()
5859
if pvName == "" {
5960
return nil, status.Errorf(codes.InvalidArgument, "pv name is missing from the request")
@@ -70,7 +71,7 @@ func (ekrs *EncryptionKeyRotationServer) EncryptionKeyRotate(
7071

7172
csiMode, err := accessmodes.ToCSIAccessMode(pv.Spec.AccessModes, true)
7273
if err != nil {
73-
klog.Errorf("Failed to map access mode: %v", err)
74+
logger.Error(err, "Failed to map access mode")
7475
return nil, status.Error(codes.InvalidArgument, err.Error())
7576
}
7677

@@ -99,7 +100,7 @@ func (ekrs *EncryptionKeyRotationServer) EncryptionKeyRotate(
99100
return nil, err
100101
}
101102

102-
klog.Infof("successfully rotated the key for pv: %s", pvName)
103+
logger.Info("Successfully rotated the key for pv", "pvName", pvName)
103104

104105
return &proto.EncryptionKeyRotateResponse{}, nil
105106
}

‎internal/sidecar/service/networkfence.go‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
"google.golang.org/grpc/codes"
2727
"google.golang.org/grpc/status"
2828
"k8s.io/client-go/kubernetes"
29-
"k8s.io/klog/v2"
29+
"sigs.k8s.io/controller-runtime/pkg/log"
3030
)
3131

3232
// NetworkFenceServer struct of sidecar with supported methods of proto
@@ -56,10 +56,11 @@ func (ns *NetworkFenceServer) RegisterService(server grpc.ServiceRegistrar) {
5656
func (ns *NetworkFenceServer) FenceClusterNetwork(
5757
ctx context.Context,
5858
req *proto.NetworkFenceRequest) (*proto.NetworkFenceResponse, error) {
59+
logger := log.FromContext(ctx)
5960
// Get the secrets from the k8s cluster
6061
data, err := kube.GetSecret(ctx, ns.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
6162
if err != nil {
62-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
63+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
6364
return nil, status.Error(codes.InvalidArgument, err.Error())
6465
}
6566

@@ -72,7 +73,7 @@ func (ns *NetworkFenceServer) FenceClusterNetwork(
7273

7374
_, err = ns.controllerClient.FenceClusterNetwork(ctx, &fenceRequest)
7475
if err != nil {
75-
klog.Errorf("Failed to fence cluster network: %v", err)
76+
logger.Error(err, "Failed to fence cluster network")
7677
return nil, err
7778
}
7879

@@ -84,10 +85,11 @@ func (ns *NetworkFenceServer) FenceClusterNetwork(
8485
func (ns *NetworkFenceServer) UnFenceClusterNetwork(
8586
ctx context.Context,
8687
req *proto.NetworkFenceRequest) (*proto.NetworkFenceResponse, error) {
88+
logger := log.FromContext(ctx)
8789
// Get the secrets from the k8s cluster
8890
data, err := kube.GetSecret(ctx, ns.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
8991
if err != nil {
90-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
92+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
9193
return nil, status.Error(codes.InvalidArgument, err.Error())
9294
}
9395

@@ -100,7 +102,7 @@ func (ns *NetworkFenceServer) UnFenceClusterNetwork(
100102

101103
_, err = ns.controllerClient.UnfenceClusterNetwork(ctx, &fenceRequest)
102104
if err != nil {
103-
klog.Errorf("Failed to unfence cluster network: %v", err)
105+
logger.Error(err, "Failed to unfence cluster network")
104106
return nil, err
105107
}
106108

@@ -121,13 +123,14 @@ func getCIDRS(cidr []string) []*fence.CIDR {
121123
func (ns *NetworkFenceServer) GetFenceClients(
122124
ctx context.Context,
123125
req *proto.FenceClientsRequest) (*proto.FenceClientsResponse, error) {
126+
logger := log.FromContext(ctx)
124127
data := map[string]string{}
125128
var err error
126129
// Get the secrets from the k8s cluster if secret name or namespace is provided
127130
if req.GetSecretName() != "" || req.GetSecretNamespace() != "" {
128131
data, err = kube.GetSecret(ctx, ns.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
129132
if err != nil {
130-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
133+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
131134
return nil, status.Error(codes.InvalidArgument, err.Error())
132135
}
133136
}
@@ -139,7 +142,7 @@ func (ns *NetworkFenceServer) GetFenceClients(
139142

140143
resp, err := ns.controllerClient.GetFenceClients(ctx, &getFenceClientRequest)
141144
if err != nil {
142-
klog.Errorf("Failed to get fence clients: %v", err)
145+
logger.Error(err, "Failed to get fence clients")
143146
return nil, err
144147
}
145148
response := &proto.FenceClientsResponse{}

‎internal/sidecar/service/reclaimspace.go‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import (
3333
corev1 "k8s.io/api/core/v1"
3434
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
3535
"k8s.io/client-go/kubernetes"
36-
"k8s.io/klog/v2"
36+
"sigs.k8s.io/controller-runtime/pkg/log"
3737
)
3838

3939
// ReclaimSpaceServer struct of sidecar with supported methods of proto
@@ -68,13 +68,14 @@ func (rs *ReclaimSpaceServer) RegisterService(server grpc.ServiceRegistrar) {
6868
func (rs *ReclaimSpaceServer) ControllerReclaimSpace(
6969
ctx context.Context,
7070
req *proto.ReclaimSpaceRequest) (*proto.ReclaimSpaceResponse, error) {
71+
logger := log.FromContext(ctx)
7172

7273
pvName := req.GetPvName()
73-
klog.Info(pvName)
74+
logger.Info("Processing ControllerReclaimSpace request", "pvName", pvName)
7475

7576
pv, err := rs.kubeClient.CoreV1().PersistentVolumes().Get(ctx, pvName, metav1.GetOptions{})
7677
if err != nil {
77-
klog.Errorf("Failed to get pv: %v", err)
78+
logger.Error(err, "Failed to get pv", "pvName", pvName)
7879
return nil, status.Errorf(codes.InvalidArgument, "failed to get pv %q", pvName)
7980
}
8081

@@ -95,7 +96,7 @@ func (rs *ReclaimSpaceServer) ControllerReclaimSpace(
9596
// Get the secrets from the k8s cluster
9697
csiReq.Secrets, err = kube.GetSecret(ctx, rs.kubeClient, pv.Spec.CSI.NodeStageSecretRef.Name, pv.Spec.CSI.NodeStageSecretRef.Namespace)
9798
if err != nil {
98-
klog.Errorf("Failed to get secret: %v", err)
99+
logger.Error(err, "Failed to get secret")
99100
return nil, status.Error(codes.InvalidArgument, err.Error())
100101
}
101102
}
@@ -123,13 +124,14 @@ func (rs *ReclaimSpaceServer) ControllerReclaimSpace(
123124
func (rs *ReclaimSpaceServer) NodeReclaimSpace(
124125
ctx context.Context,
125126
req *proto.ReclaimSpaceRequest) (*proto.ReclaimSpaceResponse, error) {
127+
logger := log.FromContext(ctx)
126128

127129
pvName := req.GetPvName()
128-
klog.Info(pvName)
130+
logger.Info("Processing NodeReclaimSpace request", "pvName", pvName)
129131

130132
pv, err := rs.kubeClient.CoreV1().PersistentVolumes().Get(ctx, pvName, metav1.GetOptions{})
131133
if err != nil {
132-
klog.Errorf("Failed to get pv: %v", err)
134+
logger.Error(err, "Failed to get pv", "pvName", pvName)
133135
return nil, status.Errorf(codes.InvalidArgument, "failed to get pv %q", pvName)
134136
}
135137

@@ -139,7 +141,7 @@ func (rs *ReclaimSpaceServer) NodeReclaimSpace(
139141
volID := pv.Spec.CSI.VolumeHandle
140142
csiMode, err := accessmodes.ToCSIAccessMode(pv.Spec.AccessModes, true)
141143
if err != nil {
142-
klog.Errorf("Failed to map access mode: %v", err)
144+
logger.Error(err, "Failed to map access mode")
143145
return nil, status.Error(codes.InvalidArgument, err.Error())
144146
}
145147

@@ -172,7 +174,7 @@ func (rs *ReclaimSpaceServer) NodeReclaimSpace(
172174
// Get the secrets from the k8s cluster
173175
csiReq.Secrets, err = kube.GetSecret(ctx, rs.kubeClient, pv.Spec.CSI.NodeStageSecretRef.Name, pv.Spec.CSI.NodeStageSecretRef.Namespace)
174176
if err != nil {
175-
klog.Errorf("Failed to get secret: %v", err)
177+
logger.Error(err, "Failed to get secret")
176178
return nil, status.Error(codes.InvalidArgument, err.Error())
177179
}
178180
}

‎internal/sidecar/service/volumegroup.go‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
"google.golang.org/grpc/codes"
2727
"google.golang.org/grpc/status"
2828
"k8s.io/client-go/kubernetes"
29-
"k8s.io/klog/v2"
29+
"sigs.k8s.io/controller-runtime/pkg/log"
3030
)
3131

3232
// VolumeGroupServer struct of sidecar with supported methods of proto
@@ -56,10 +56,11 @@ func (vg *VolumeGroupServer) RegisterService(server grpc.ServiceRegistrar) {
5656
func (vg *VolumeGroupServer) CreateVolumeGroup(
5757
ctx context.Context,
5858
req *proto.CreateVolumeGroupRequest) (*proto.CreateVolumeGroupResponse, error) {
59+
logger := log.FromContext(ctx)
5960
// Get the secrets from the k8s cluster
6061
data, err := kube.GetSecret(ctx, vg.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
6162
if err != nil {
62-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
63+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
6364
return nil, status.Error(codes.Internal, err.Error())
6465
}
6566
// Get the VolumeGroup name and volumeIds from the request
@@ -72,7 +73,7 @@ func (vg *VolumeGroupServer) CreateVolumeGroup(
7273

7374
vgResp, err := vg.controllerClient.CreateVolumeGroup(ctx, vgReq)
7475
if err != nil {
75-
klog.Errorf("Failed to create volume group: %v", err)
76+
logger.Error(err, "Failed to create volume group")
7677
return nil, err
7778
}
7879

@@ -94,10 +95,11 @@ func (vg *VolumeGroupServer) CreateVolumeGroup(
9495
func (vg *VolumeGroupServer) ModifyVolumeGroupMembership(
9596
ctx context.Context,
9697
req *proto.ModifyVolumeGroupMembershipRequest) (*proto.ModifyVolumeGroupMembershipResponse, error) {
98+
logger := log.FromContext(ctx)
9799
// Get the secrets from the k8s cluster
98100
data, err := kube.GetSecret(ctx, vg.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
99101
if err != nil {
100-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
102+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
101103
return nil, status.Error(codes.Internal, err.Error())
102104
}
103105
// Get the volumeGroup Id and volumeIds from the request
@@ -110,7 +112,7 @@ func (vg *VolumeGroupServer) ModifyVolumeGroupMembership(
110112

111113
vgResp, err := vg.controllerClient.ModifyVolumeGroupMembership(ctx, vgReq)
112114
if err != nil {
113-
klog.Errorf("Failed to modify volume group: %v", err)
115+
logger.Error(err, "Failed to modify volume group")
114116
return nil, err
115117
}
116118

@@ -132,10 +134,11 @@ func (vg *VolumeGroupServer) ModifyVolumeGroupMembership(
132134
func (vg *VolumeGroupServer) DeleteVolumeGroup(
133135
ctx context.Context,
134136
req *proto.DeleteVolumeGroupRequest) (*proto.DeleteVolumeGroupResponse, error) {
137+
logger := log.FromContext(ctx)
135138
// Get the secrets from the k8s cluster
136139
data, err := kube.GetSecret(ctx, vg.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
137140
if err != nil {
138-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
141+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
139142
return nil, status.Error(codes.Internal, err.Error())
140143
}
141144
// Get the volumeGroup Id from the request
@@ -146,7 +149,7 @@ func (vg *VolumeGroupServer) DeleteVolumeGroup(
146149

147150
_, err = vg.controllerClient.DeleteVolumeGroup(ctx, vgReq)
148151
if err != nil {
149-
klog.Errorf("Failed to delete volume group: %v", err)
152+
logger.Error(err, "Failed to delete volume group")
150153
return nil, err
151154
}
152155

@@ -157,10 +160,11 @@ func (vg *VolumeGroupServer) DeleteVolumeGroup(
157160
func (vg *VolumeGroupServer) ControllerGetVolumeGroup(
158161
ctx context.Context,
159162
req *proto.ControllerGetVolumeGroupRequest) (*proto.ControllerGetVolumeGroupResponse, error) {
163+
logger := log.FromContext(ctx)
160164
// Get the secrets from the k8s cluster
161165
data, err := kube.GetSecret(ctx, vg.kubeClient, req.GetSecretName(), req.GetSecretNamespace())
162166
if err != nil {
163-
klog.Errorf("Failed to get secret %s in namespace %s: %v", req.GetSecretName(), req.GetSecretNamespace(), err)
167+
logger.Error(err, "Failed to get secret", "secretName", req.GetSecretName(), "secretNamespace", req.GetSecretNamespace())
164168
return nil, status.Error(codes.Internal, err.Error())
165169
}
166170
// Get the volumeGroup Id from the request
@@ -171,7 +175,7 @@ func (vg *VolumeGroupServer) ControllerGetVolumeGroup(
171175

172176
vgResp, err := vg.controllerClient.ControllerGetVolumeGroup(ctx, vgReq)
173177
if err != nil {
174-
klog.Errorf("Failed to get volume group: %v", err)
178+
logger.Error(err, "Failed to get volume group")
175179
return nil, err
176180
}
177181

0 commit comments

Comments
 (0)