Migrate verbosity-based info logging to contextual logging #9707

anndono · 2025-12-03T02:20:02Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

This PR improves logging consistency by migrating parts of the codebase from mixed plain-text and structural logging to contextual logging.

Changes:

Replaced occurrences of: klog.V(n).Infof/klog.V(n).Info/klog.V(n).InfoS with logger.V(n).Info for contextual logging
Updated certain Info logs to Error logs where error details are present

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

k8s-ci-robot · 2025-12-03T02:20:12Z

Hi @anndono. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot · 2025-12-03T02:20:12Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: anndono
Once this PR has been reviewed and has the lgtm label, please assign cheftako for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

nilo19 · 2025-12-03T02:32:03Z

/ok-to-test

nilo19 · 2025-12-03T02:47:29Z

Please fix the linting issue. You may use the corresponding makefile target to check linting locally. Both for main module and pkg/azclient module (there are two makefiles separatedly).

Copilot

Pull request overview

This PR migrates logging from the traditional klog.V(n).Infof/Info/InfoS pattern to contextual logging using logger.V(n).Info with structured key-value pairs. The changes also convert some Info logs to Error logs where error details are present, improving logging consistency across the codebase.

Key changes:

Replaced klog verbosity-based logging with contextual logger.V(n).Info throughout the codebase
Introduced log.Background().WithName() pattern for logger initialization in functions
Converted formatted string messages to structured key-value logging
Updated certain Info logs to Error logs where errors are being logged

Reviewed changes

Copilot reviewed 49 out of 52 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
pkg/util/node/node.go	Migrated PatchNodeCIDRs logging to contextual logging
pkg/util/controller/node/controller_utils.go	Updated RecordNodeStatusChange logging
pkg/provider/subnet/subnet.go	Converted SubnetsClient logging to structured format
pkg/provider/storage/*.go	Migrated storage-related logging across multiple files
pkg/provider/securitygroup/*.go	Updated security group operation logging
pkg/provider/azure_zones.go	Converted zone-related logging to contextual format
pkg/provider/azure_vmssflex*.go	Migrated VMSS Flex logging throughout
pkg/provider/azure_vmss*.go	Updated VMSS operation logging
pkg/provider/azure_standard.go	Converted availability set logging
pkg/provider/azure_loadbalancer*.go	Extensive migration of load balancer logging
pkg/provider/azure_routes.go	Updated route management logging
pkg/provider/azure*.go	Various provider operation logging updates
pkg/nodemanager/nodemanager.go	Migrated node manager logging
pkg/nodeipam/ipam/*.go	Updated IPAM allocator logging
pkg/metrics/azure_metrics.go	Converted metrics logging
pkg/credentialprovider/*.go	Updated credential provider logging
pkg/azclient/policy/retryaftermin/*.go	Migrated retry policy logging

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

nilo19 · 2025-12-03T06:13:37Z

/retest

nilo19 · 2025-12-03T11:24:08Z

/retest

nilo19 · 2025-12-04T00:02:05Z

/retest

nilo19 · 2025-12-04T02:45:34Z

/retest

nilo19 · 2025-12-04T02:49:56Z

@anndono azclient still failed to build

nilo19 · 2025-12-04T08:56:47Z

/retest

nilo19 · 2025-12-04T11:04:03Z

/retest

nilo19 · 2025-12-04T22:45:21Z

/retest

nilo19 · 2025-12-05T04:52:18Z

pkg/azclient/go.mod

-	k8s.io/klog/v2 v2.130.1
-	k8s.io/utils v0.0.0-20241210054802-24370beab758
+	k8s.io/utils v0.0.0-20250820121507-0af2bda4dd1d
+	sigs.k8s.io/cloud-provider-azure v1.34.3


better to have a dedicated logger package in azclient (though there would be duplications) than circular import a huge package here.

Reverted the import and updated the code to use the existing package instead.

nilo19 · 2025-12-15T08:48:33Z

related: #1575

Copilot

Pull request overview

Copilot reviewed 48 out of 48 changed files in this pull request and generated 9 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-15T09:13:22Z

pkg/provider/storage/azure_storageaccount.go

 		_ = az.storageAccountCache.Delete(account) // clean cache
 		updateParams := &armstorage.AccountUpdateParameters{Tags: newTags}
-		klog.V(2).Infof("add storage account(%s) with tags(%+v)", account, newTags)
+		logger.V(2).Info("", "account", account, "tags", newTags)


The log message is empty. Based on the context (adding storage account with tags), this should have a meaningful message like "add storage account with tags".

Copilot · 2025-12-15T09:13:23Z

pkg/provider/storage/azure_storageaccount.go

 		_ = az.storageAccountCache.Delete(account) // clean cache
 		updateParams := &armstorage.AccountUpdateParameters{Tags: result.Tags}
-		klog.V(2).Infof("remove tag(%s) from storage account(%s)", key, account)
+		logger.V(2).Info("", "tag", key, "account", account)


The log message is empty. Based on the context (removing tag from storage account), this should have a meaningful message like "remove tag from storage account".

Copilot · 2025-12-15T09:13:23Z

pkg/provider/azure_vmss.go

 				vmss = v
 			}
-			klog.V(2).Infof("ensureBackendPoolDeletedFromVmssUniform: vmss %q, backendPoolIDs %q", ptr.Deref(vmss.Name, ""), backendPoolIDs)
+			logger.V(2).Info("", "vmssName", ptr.Deref(vmss.Name, ""), "backendPoolIDs", backendPoolIDs)


The log message is empty. Based on the context, this should have a meaningful message describing what is being logged about the vmss name and backendPoolIDs.

pkg/provider/azure_vmssflex.go

Copilot · 2025-12-15T09:13:23Z

pkg/provider/azure_privatelinkservice.go

+	logger.V(2).Info("",
+		"service", serviceName,
+		"LB fipConfigID", ptr.Deref(fipConfig.Name, ""),
+		"wantPLS", wantPLS,
+		"createPLS", createPLS)


The log message is empty. Based on the context, this should have a meaningful message like "reconcilePrivateLinkService for service".

pkg/provider/azure_utils.go

pkg/credentialprovider/azure_acr_helper.go

pkg/provider/azure_vmss.go

pkg/provider/azure_loadbalancer.go

nilo19 · 2025-12-15T09:14:15Z

pkg/provider/azure_privatelinkservice.go

 		exists := !strings.EqualFold(ptr.Deref(existingPLS.ID, ""), consts.PrivateLinkServiceNotExistID)
 		if exists {
-			klog.V(4).Infof("reconcilePrivateLinkService for service(%s): found existing private link service attached(%s)", serviceName, ptr.Deref(existingPLS.Name, ""))
+			logger.V(4).Info("found existing private link service attached(%s)", "service", serviceName, "privateLinkService", ptr.Deref(existingPLS.Name, ""))


Please don't use %s anymore after the migration. Please double check if there are other places having this issue.

health-probe-proxy/main.go

nilo19 · 2025-12-15T09:27:25Z

cmd/cloud-controller-manager/app/controllermanager.go


 // RunWrapper adapts the ccm boot logic to the leader elector call back function
 func RunWrapper(s *options.CloudControllerManagerOptions, c *cloudcontrollerconfig.Config, h *controllerhealthz.MutableHealthzHandler) func(ctx context.Context) {
 	logger := log.Background().WithName("RunWrapper")


Shouldn't use Background context if there is an existing context. Maybe we can have another PR addressing this issue?

nilo19 · 2025-12-15T09:28:41Z

pkg/provider/azure_loadbalancer.go

 			// service is not on this load balancer
 			continue
 		}
 		logger.V(4).Info(fmt.Sprintf("getServiceLoadBalancer(%s, %s, %v): current lb IPs: %q", service.Name, clusterName, wantLb, lbIPsPrimaryPIPs))


shouldn't use sprintf. should be key-value pairs. Check other places please.

k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesn't merit a release note. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 3, 2025

github-actions bot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Dec 3, 2025

k8s-ci-robot requested review from elmiko and feiskyer December 3, 2025 02:20

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 3, 2025

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 3, 2025

nilo19 requested a review from Copilot December 3, 2025 02:45

Copilot started reviewing on behalf of nilo19 December 3, 2025 02:46 View session

Copilot finished reviewing on behalf of nilo19 December 3, 2025 02:46

Copilot AI reviewed Dec 3, 2025

View reviewed changes

anndono force-pushed the chengan/migrate-to-contextual-logging-with-verbosity branch from e60fb0a to d51eec5 Compare December 3, 2025 05:32

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 3, 2025

anndono force-pushed the chengan/migrate-to-contextual-logging-with-verbosity branch from d51eec5 to 61bc582 Compare December 3, 2025 22:56

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 3, 2025

anndono force-pushed the chengan/migrate-to-contextual-logging-with-verbosity branch from 61bc582 to 3d73d06 Compare December 4, 2025 00:46

anndono force-pushed the chengan/migrate-to-contextual-logging-with-verbosity branch from 3d73d06 to 6c70306 Compare December 4, 2025 04:33

nilo19 reviewed Dec 5, 2025

View reviewed changes

Revert changes in sub modules

34229bf

anndono force-pushed the chengan/migrate-to-contextual-logging-with-verbosity branch from 6c70306 to 34229bf Compare December 14, 2025 23:57

Fix go module issue

65f7604

nilo19 requested a review from Copilot December 15, 2025 09:01

Copilot started reviewing on behalf of nilo19 December 15, 2025 09:03 View session

Copilot AI reviewed Dec 15, 2025

View reviewed changes

nilo19 reviewed Dec 15, 2025

View reviewed changes

health-probe-proxy/main.go Show resolved Hide resolved

nilo19 reviewed Dec 15, 2025

View reviewed changes

Migrate verbosity-based info logging to contextual logging #9707

Are you sure you want to change the base?

Migrate verbosity-based info logging to contextual logging #9707

Conversation

anndono commented Dec 3, 2025

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Uh oh!

k8s-ci-robot commented Dec 3, 2025

Uh oh!

k8s-ci-robot commented Dec 3, 2025

Uh oh!

nilo19 commented Dec 3, 2025

Uh oh!

nilo19 commented Dec 3, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

nilo19 commented Dec 3, 2025

Uh oh!

nilo19 commented Dec 3, 2025

Uh oh!

nilo19 commented Dec 4, 2025

Uh oh!

nilo19 commented Dec 4, 2025

Uh oh!

nilo19 commented Dec 4, 2025

Uh oh!

nilo19 commented Dec 4, 2025

Uh oh!

nilo19 commented Dec 4, 2025

Uh oh!

nilo19 commented Dec 4, 2025

Uh oh!

nilo19 Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

anndono Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

nilo19 commented Dec 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nilo19 Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nilo19 Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

nilo19 Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!