migrate verbose info logging to contextual logging across remaining folders

Author: anndono

pkg/provider/securitygroup/azure_securitygroup_repo.go

@@ -34,6 +34,7 @@ import (
 	"sigs.k8s.io/cloud-provider-azure/pkg/azclient/securitygroupclient"
 	azcache "sigs.k8s.io/cloud-provider-azure/pkg/cache"
 	"sigs.k8s.io/cloud-provider-azure/pkg/consts"
+	"sigs.k8s.io/cloud-provider-azure/pkg/log"
 	"sigs.k8s.io/cloud-provider-azure/pkg/util/errutils"
 )
 
@@ -55,6 +56,7 @@ type securityGroupRepo struct {
 }
 
 func NewSecurityGroupRepo(securityGroupResourceGroup string, securityGroupName string, nsgCacheTTLInSeconds int, disableAPICallCache bool, securityGroupClient securitygroupclient.Interface) (Repository, error) {
+	logger := log.Background().WithName("NewSecurityGroupRepo")
 	getter := func(ctx context.Context, key string) (interface{}, error) {
 		nsg, err := securityGroupClient.Get(ctx, securityGroupResourceGroup, key)
 		exists, rerr := errutils.CheckResourceExistsFromAzcoreError(err)
@@ -63,7 +65,7 @@ func NewSecurityGroupRepo(securityGroupResourceGroup string, securityGroupName s
 		}
 
 		if !exists {
-			klog.V(2).Infof("Security group %q not found", key)
+			logger.V(2).Info("Security group not found", "securityGroup", key)
 			return nil, nil
 		}
 
@@ -90,8 +92,9 @@ func NewSecurityGroupRepo(securityGroupResourceGroup string, securityGroupName s
 
 // CreateOrUpdateSecurityGroup invokes az.SecurityGroupsClient.CreateOrUpdate with exponential backoff retry
 func (az *securityGroupRepo) CreateOrUpdateSecurityGroup(ctx context.Context, sg *armnetwork.SecurityGroup) error {
+	logger := log.Background().WithName("CreateOrUpdateSecurityGroup")
 	_, rerr := az.securigyGroupClient.CreateOrUpdate(ctx, az.securityGroupResourceGroup, *sg.Name, *sg)
-	klog.V(10).Infof("SecurityGroupsClient.CreateOrUpdate(%s): end", *sg.Name)
+	logger.V(10).Info("SecurityGroupsClient.CreateOrUpdate: end", "securityGroupName", *sg.Name)
 	if rerr == nil {
 		// Invalidate the cache right after updating
 		_ = az.nsgCache.Delete(*sg.Name)
@@ -104,13 +107,13 @@ func (az *securityGroupRepo) CreateOrUpdateSecurityGroup(ctx context.Context, sg
 
 		// Invalidate the cache because ETAG precondition mismatch.
 		if respError.StatusCode == http.StatusPreconditionFailed {
-			klog.V(3).Infof("SecurityGroup cache for %s is cleanup because of http.StatusPreconditionFailed", *sg.Name)
+			logger.V(3).Info("SecurityGroup cache is cleanup because of http.StatusPreconditionFailed", "securityGroupName", *sg.Name)
 			_ = az.nsgCache.Delete(*sg.Name)
 		}
 
 		// Invalidate the cache because another new operation has canceled the current request.
 		if strings.Contains(strings.ToLower(respError.Error()), consts.OperationCanceledErrorMessage) {
-			klog.V(3).Infof("SecurityGroup cache for %s is cleanup because CreateOrUpdateSecurityGroup is canceled by another operation", *sg.Name)
+			logger.V(3).Info("SecurityGroup cache is cleanup because CreateOrUpdateSecurityGroup is canceled by another operation", "securityGroupName", *sg.Name)
 			_ = az.nsgCache.Delete(*sg.Name)
 		}
 	}

pkg/provider/storage/azure_storageaccount.go

@@ -23,10 +23,10 @@ import (
 	"time"
 
 	armstorage "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage/v2"
-	"k8s.io/klog/v2"
 
 	"sigs.k8s.io/cloud-provider-azure/pkg/azclient"
 	"sigs.k8s.io/cloud-provider-azure/pkg/azclient/cache"
+	"sigs.k8s.io/cloud-provider-azure/pkg/log"
 	azureconfig "sigs.k8s.io/cloud-provider-azure/pkg/provider/config"
 )
 
@@ -52,6 +52,7 @@ func NewRepository(config azureconfig.Config, clientFactory azclient.ClientFacto
 	}, nil
 }
 func (az *fileServicePropertiesRepo) Get(ctx context.Context, subsID, resourceGroup, account string) (*armstorage.FileServiceProperties, error) {
+	logger := log.Background().WithName("Get")
 	if az.clientFactory == nil {
 		return nil, fmt.Errorf("clientFactory is nil")
 	}
@@ -65,7 +66,7 @@ func (az *fileServicePropertiesRepo) Get(ctx context.Context, subsID, resourceGr
 		return nil, err
 	}
 	if cache != nil {
-		klog.V(2).Infof("Get service properties(%s) from cache", account)
+		logger.V(2).Info("Get service properties from cache", "account", account)
 		return cache, nil
 	}
 

pkg/provider/storage/fileservice/fileservice_repo.go

@@ -22,14 +22,14 @@ import (
 	"strings"
 	"time"
 
-	"k8s.io/klog/v2"
-
 	"sigs.k8s.io/cloud-provider-azure/pkg/azclient/accountclient"
+	"sigs.k8s.io/cloud-provider-azure/pkg/log"
 )
 
 // GetStorageAccesskey gets the storage account access key
 // getLatestAccountKey: get the latest account key per CreationTime if true, otherwise get the first account key
 func GetStorageAccesskey(ctx context.Context, saClient accountclient.Interface, account, resourceGroup string, getLatestAccountKey bool) (string, error) {
+	logger := log.Background().WithName("GetStorageAccesskey")
 	if saClient == nil {
 		return "", fmt.Errorf("StorageAccountClient is nil")
 	}
@@ -61,12 +61,12 @@ func GetStorageAccesskey(ctx context.Context, saClient accountclient.Interface,
 				if k.CreationTime != nil {
 					creationTime = *k.CreationTime
 				}
-				klog.V(2).Infof("got storage account key with creation time: %v", creationTime)
+				logger.V(2).Info("got storage account key with creation time", "creationTime", creationTime)
 			} else {
 				if k.CreationTime != nil && creationTime.Before(*k.CreationTime) {
 					key = v
 					creationTime = *k.CreationTime
-					klog.V(2).Infof("got storage account key with latest creation time: %v", creationTime)
+					logger.V(2).Info("got storage account key with latest creation time", "creationTime", creationTime)
 				}
 			}
 		}

pkg/provider/storage/storage_account.go

@@ -23,6 +23,7 @@ import (
 	"k8s.io/klog/v2"
 
 	"sigs.k8s.io/cloud-provider-azure/pkg/azclient/subnetclient"
+	"sigs.k8s.io/cloud-provider-azure/pkg/log"
 )
 
 type Repository interface {
@@ -42,8 +43,9 @@ func NewRepo(subnetsClient subnetclient.Interface) (Repository, error) {
 
 // CreateOrUpdateSubnet invokes az.SubnetClient.CreateOrUpdate with exponential backoff retry
 func (az *repo) CreateOrUpdate(ctx context.Context, rg string, vnetName string, subnetName string, subnet armnetwork.Subnet) error {
+	logger := log.Background().WithName("SubnetsClient.CreateOrUpdate")
 	_, rerr := az.SubnetsClient.CreateOrUpdate(ctx, rg, vnetName, subnetName, subnet)
-	klog.V(10).Infof("SubnetsClient.CreateOrUpdate(%s): end", subnetName)
+	logger.V(10).Info("end", "subnetName", subnetName)
 	if rerr != nil {
 		klog.Errorf("SubnetClient.CreateOrUpdate(%s) failed: %s", subnetName, rerr.Error())
 		return rerr

pkg/provider/subnet/subnet.go

@@ -24,6 +24,8 @@ import (
 	"k8s.io/client-go/tools/cache"
 	"k8s.io/client-go/tools/record"
 	"k8s.io/klog/v2"
+
+	"sigs.k8s.io/cloud-provider-azure/pkg/log"
 )
 
 // CreateAddNodeHandler creates an add node handler.
@@ -89,14 +91,15 @@ func GetNodeCondition(status *v1.NodeStatus, conditionType v1.NodeConditionType)
 
 // RecordNodeStatusChange records a event related to a node status change. (Common to lifecycle and ipam)
 func RecordNodeStatusChange(recorder record.EventRecorder, node *v1.Node, newStatus string) {
+	logger := log.Background().WithName("RecordNodeStatusChange")
 	ref := &v1.ObjectReference{
 		APIVersion: "v1",
 		Kind:       "Node",
 		Name:       node.Name,
 		UID:        node.UID,
 		Namespace:  "",
 	}
-	klog.V(2).Infof("Recording status change %s event message for node %s", newStatus, node.Name)
+	logger.V(2).Info("Recording status change event message for node", "status", newStatus, "node", node.Name)
 	// TODO: This requires a transaction, either both node status is updated
 	// and event is recorded or neither should happen, see issue #6055.
 	recorder.Eventf(ref, v1.EventTypeNormal, newStatus, "Node %s status is now: %s", node.Name, newStatus)

pkg/util/controller/node/controller_utils.go

@@ -26,7 +26,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	clientset "k8s.io/client-go/kubernetes"
-	"k8s.io/klog/v2"
+
+	"sigs.k8s.io/cloud-provider-azure/pkg/log"
 )
 
 type nodeForCIDRMergePatch struct {
@@ -66,6 +67,7 @@ func PatchNodeCIDR(c clientset.Interface, node types.NodeName, cidr string) erro
 
 // PatchNodeCIDRs patches the specified node.CIDR=cidrs[0] and node.CIDRs to the given value.
 func PatchNodeCIDRs(c clientset.Interface, node types.NodeName, cidrs []string) error {
+	logger := log.Background().WithName("PatchNodeCIDRs")
 	// set the pod cidrs list and set the old pod cidr field
 	patch := nodeForCIDRMergePatch{
 		Spec: nodeSpecForMergePatch{
@@ -78,7 +80,7 @@ func PatchNodeCIDRs(c clientset.Interface, node types.NodeName, cidrs []string)
 	if err != nil {
 		return fmt.Errorf("failed to json.Marshal CIDR: %w", err)
 	}
-	klog.V(4).Infof("cidrs patch bytes for node %s are:%s", string(node), string(patchBytes))
+	logger.V(4).Info("cidrs patch bytes for node", "node", string(node), "cidrsPatchBytes", string(patchBytes))
 	if _, err := c.CoreV1().Nodes().Patch(context.TODO(), string(node), types.StrategicMergePatchType, patchBytes, metav1.PatchOptions{}); err != nil {
 		return fmt.Errorf("failed to patch node CIDR: %w", err)
 	}