feature: migrate contextual logging #1613

googs1025 · 2025-01-25T11:34:42Z

k8s-ci-robot · 2025-01-25T11:34:57Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

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

googs1025 · 2025-01-30T08:58:04Z

@a7i @ingvagabund /PTAL

ricardomaraschini

Wow, what an amazing work you have done. Thanks for taking the time to get this in. I have left a few comments.

ricardomaraschini · 2025-02-18T14:52:44Z

pkg/descheduler/leaderelection.go

@@ -46,7 +47,7 @@ func NewLeaderElection(
 		id = hostname + "_" + string(uuid.NewUUID())
 	}

-	klog.V(3).Infof("Assigned unique lease holder id: %s", id)
+	logger.V(3).Info(fmt.Sprintf("Assigned unique lease holder id: %s", id))


Wouldn't this be better ?

logger.V(3).Info("Assigned unique lease holder id", "id", id)

ricardomaraschini · 2025-02-18T14:54:46Z

pkg/descheduler/leaderelection.go

 			},
 			OnNewLeader: func(identity string) {
 				// Just got the lock
 				if identity == id {
 					return
 				}
-				klog.V(1).Infof("New leader elected: %v", identity)
+				logger.V(1).Info(fmt.Sprintf("New leader elected: %v", identity))


ricardomaraschini · 2025-02-18T15:02:58Z

pkg/descheduler/metricscollector/metricscollector.go

@@ -93,11 +93,12 @@ func (mc *MetricsCollector) AllNodesUsage() (map[string]map[v1.ResourceName]*res
 }

 func (mc *MetricsCollector) NodeUsage(node *v1.Node) (map[v1.ResourceName]*resource.Quantity, error) {
+	logger := klog.FromContext(context.TODO())


I am not entirely sure we should have this TODO() added to the code. The enhancement proposal mentions that the logger should either come in as part of a Context or as an explicit argument. Any reason for not receiving it as part of an existing Context ?

ricardomaraschini · 2025-02-18T15:05:00Z

pkg/descheduler/node/node.go

 			return false
 		}*/
 	}
 	// Ignore nodes that are marked unschedulable
 	/*if node.Spec.Unschedulable {
-		klog.V(4).InfoS("Ignoring node since it is unschedulable", "node", klog.KObj(node.Name))
+		logger..V(4).Info("Ignoring node since it is unschedulable", "node", klog.KObj(node.Name))


This seems to be commented out but there is an extra . we should get rid of.

ricardomaraschini · 2025-02-18T15:14:52Z

pkg/descheduler/pod/pods.go

@@ -157,7 +158,7 @@ func ConvertToPods(objs []interface{}, filter FilterFunc) []*v1.Pod {
 		if !ok {
 			continue
 		}
-		if filter == nil || filter(pod) {
+		if filter == nil || filter(context.TODO(), pod) {


Shouldn't GetPodsAssignedToNodeFunc type also receive a Context as argument ? I mean, now that FilterFunc also requires one to be passed in ?

ricardomaraschini · 2025-02-18T15:24:57Z

pkg/framework/pluginregistry/pluginregistry.go

@@ -57,8 +59,9 @@ func Register(
 	pluginArgDefaulter PluginArgDefaulter,
 	registry Registry,
 ) {
+	logger := klog.FromContext(context.TODO())


Shouldn't this logger be received through an argument ? Or maybe a Context.

ricardomaraschini · 2025-02-18T15:27:14Z

pkg/framework/plugins/defaultevictor/defaultevictor.go

@@ -72,13 +72,15 @@ func New(args runtime.Object, handle frameworktypes.Handle) (frameworktypes.Plug
 		return nil, fmt.Errorf("want args to be of type defaultEvictorFilterArgs, got %T", args)
 	}

+	logger := klog.FromContext(context.TODO())


Ditto. I don't think we should be introducing new TODO() here. We could pass in the logger or a context.

ricardomaraschini · 2025-02-18T15:27:58Z

pkg/framework/plugins/defaultevictor/validation.go

@@ -23,13 +24,14 @@ import (

 func ValidateDefaultEvictorArgs(obj runtime.Object) error {
 	args := obj.(*DefaultEvictorArgs)
+	logger := klog.FromContext(context.TODO())


ricardomaraschini · 2025-02-18T15:36:59Z

pkg/framework/plugins/removefailedpods/failedpods.go

 		if err := validateCanEvict(pod, failedPodsArgs); err != nil {
-			klog.V(4).InfoS(fmt.Sprintf("ignoring pod for eviction due to: %s", err.Error()), "pod", klog.KObj(pod))
+			logger.V(4).Info(fmt.Sprintf("ignoring pod for eviction due to: %s", err.Error()), "pod", klog.KObj(pod))


Shouldn't we be getting the logger from the Context received as an argument here ? More, if we do that then we can get rid of the line 52 above.

ricardomaraschini · 2025-02-18T15:39:19Z

pkg/framework/plugins/removepodshavingtoomanyrestarts/toomanyrestarts.go

 		if err := validateCanEvict(pod, tooManyRestartsArgs); err != nil {
-			klog.V(4).InfoS(fmt.Sprintf("ignoring pod for eviction due to: %s", err.Error()), "pod", klog.KObj(pod))
+			logger.V(4).Info(fmt.Sprintf("ignoring pod for eviction due to: %s", err.Error()), "pod", klog.KObj(pod))


Same thing here as my previous comment. I think we want to get the logger from the context received as an argument here as well.

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 25, 2025

k8s-ci-robot requested review from ingvagabund and JaneLiuL January 25, 2025 11:34

googs1025 force-pushed the contextual_logging branch 3 times, most recently from 92cee90 to 6377812 Compare January 25, 2025 12:35

ricardomaraschini reviewed Feb 18, 2025

View reviewed changes

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

googs1025 force-pushed the contextual_logging branch from 6377812 to 42303fd Compare February 19, 2025 02:04

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 19, 2025

googs1025 force-pushed the contextual_logging branch from 42303fd to 73764a5 Compare February 19, 2025 02:09

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

googs1025 force-pushed the contextual_logging branch 6 times, most recently from 2bb3baf to 627da1c Compare February 19, 2025 03:16

feature: migrate contextual logging

d33c671

googs1025 force-pushed the contextual_logging branch from 627da1c to d33c671 Compare February 19, 2025 03:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: migrate contextual logging #1613

feature: migrate contextual logging #1613

googs1025 commented Jan 25, 2025

k8s-ci-robot commented Jan 25, 2025

googs1025 commented Jan 30, 2025

ricardomaraschini left a comment

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

ricardomaraschini Feb 18, 2025

googs1025 Feb 19, 2025

feature: migrate contextual logging #1613

Are you sure you want to change the base?

feature: migrate contextual logging #1613

Conversation

googs1025 commented Jan 25, 2025

k8s-ci-robot commented Jan 25, 2025

googs1025 commented Jan 30, 2025

ricardomaraschini left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment