fix: use existing context when ctx is available (#9773)

* fix: use existing context when ctx is available

* Replace klog.Background() to use existing context when ctx is available

Author: anndono

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

@@ -211,8 +211,8 @@ func NewCloudControllerManagerCommand() *cobra.Command {
 
 // 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")
 	return func(ctx context.Context) {
+		logger := log.FromContextOrBackground(ctx).WithName("RunWrapper")
 		if !c.DynamicReloadingConfig.EnableDynamicReloading {
 			logger.V(1).Info("using static initialization from config file", "cloudConfigFile", c.ComponentConfig.KubeCloudShared.CloudProvider.CloudConfigFile)
 			if err := Run(ctx, c.Complete(), h); err != nil {
@@ -289,8 +289,8 @@ func shouldDisableCloudProvider(configFilePath string) (bool, error) {
 }
 
 func runAsync(s *options.CloudControllerManagerOptions, errCh chan error, h *controllerhealthz.MutableHealthzHandler) context.CancelFunc {
-	logger := log.Background().WithName("runAsync")
 	ctx, cancelFunc := context.WithCancel(context.Background())
+	logger := log.FromContextOrBackground(ctx).WithName("runAsync")
 
 	go func() {
 		c, err := s.Config(KnownControllers(), ControllersDisabledByDefault.List(), names.CCMControllerAliases())
@@ -344,7 +344,7 @@ func StartHTTPServer(ctx context.Context, c *cloudcontrollerconfig.CompletedConf
 
 // Run runs the ExternalCMServer.  This should never exit.
 func Run(ctx context.Context, c *cloudcontrollerconfig.CompletedConfig, h *controllerhealthz.MutableHealthzHandler) error {
-	logger := log.Background().WithName("Run")
+	logger := log.FromContextOrBackground(ctx).WithName("Run")
 	// To help debugging, immediately log version
 	logger.Info("Version", "version", version.Get())
 
@@ -401,7 +401,7 @@ func Run(ctx context.Context, c *cloudcontrollerconfig.CompletedConfig, h *contr
 // startControllers starts the cloud specific controller loops.
 func startControllers(ctx context.Context, controllerContext genericcontrollermanager.ControllerContext, completedConfig *cloudcontrollerconfig.CompletedConfig,
 	cloud cloudprovider.Interface, controllers map[string]initFunc, healthzHandler *controllerhealthz.MutableHealthzHandler) error {
-	logger := log.Background().WithName("startControllers")
+	logger := log.FromContextOrBackground(ctx).WithName("startControllers")
 	// Initialize the cloud provider with a reference to the clientBuilder
 	cloud.Initialize(completedConfig.ClientBuilder, ctx.Done())
 	// Set the informer on the user cloud object

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

@@ -105,7 +105,7 @@ func startServiceController(ctx context.Context, controllerContext genericcontro
 }
 
 func startRouteController(ctx context.Context, controllerContext genericcontrollermanager.ControllerContext, completedConfig *cloudcontrollerconfig.CompletedConfig, cloud cloudprovider.Interface) (http.Handler, bool, error) {
-	logger := log.Background().WithName("startRouteController")
+	logger := log.FromContextOrBackground(ctx).WithName("startRouteController")
 	if !completedConfig.ComponentConfig.KubeCloudShared.ConfigureCloudRoutes {
 		logger.Info("Will not configure cloud provider routes", "--configure-cloud-routes", completedConfig.ComponentConfig.KubeCloudShared.ConfigureCloudRoutes)
 		return nil, false, nil

cmd/cloud-node-manager/app/nodemanager.go

@@ -95,7 +95,7 @@ func NewCloudNodeManagerCommand() *cobra.Command {
 
 // Run runs the ExternalCMServer.  This should never exit.
 func Run(ctx context.Context, c *cloudnodeconfig.Config) error {
-	logger := log.Background().WithName("Run")
+	logger := log.FromContextOrBackground(ctx).WithName("Run")
 	// To help debugging, immediately log version and nodeName
 	logger.Info("Version", "version", version.Get())
 	logger.Info("NodeName", "nodeName", c.NodeName)
@@ -124,7 +124,7 @@ func Run(ctx context.Context, c *cloudnodeconfig.Config) error {
 
 // startControllers starts the cloud specific controller loops.
 func startControllers(ctx context.Context, c *cloudnodeconfig.Config, healthzHandler *controllerhealthz.MutableHealthzHandler) error {
-	logger := log.Background().WithName("startControllers")
+	logger := log.FromContextOrBackground(ctx).WithName("startControllers")
 	logger.V(1).Info("Starting cloud-node-manager...")
 
 	// Start the CloudNodeController

pkg/credentialprovider/azure_credentials.go

@@ -68,8 +68,9 @@ type acrProvider struct {
 }
 
 func NewAcrProvider(req *v1.CredentialProviderRequest, registryMirrorStr string, configFile string, ibConfig IdentityBindingsConfig) (CredentialProvider, error) {
-	logger := log.Background().WithName("NewAcrProvider")
-	config, err := configloader.Load[providerconfig.AzureClientConfig](context.Background(), nil, &configloader.FileLoaderConfig{FilePath: configFile})
+	ctx := context.Background()
+	logger := log.FromContextOrBackground(ctx).WithName("NewAcrProvider")
+	config, err := configloader.Load[providerconfig.AzureClientConfig](ctx, nil, &configloader.FileLoaderConfig{FilePath: configFile})
 	if err != nil {
 		return nil, fmt.Errorf("failed to load config: %w", err)
 	}
@@ -184,7 +185,7 @@ func getServiceAccountTokenCredential(req *v1.CredentialProviderRequest, config
 }
 
 func (a *acrProvider) GetCredentials(ctx context.Context, image string, _ []string) (*v1.CredentialProviderResponse, error) {
-	logger := log.Background().WithName("GetCredentials")
+	logger := log.FromContextOrBackground(ctx).WithName("GetCredentials")
 	targetloginServer, sourceloginServer := a.parseACRLoginServerFromImage(image)
 	if targetloginServer == "" {
 		logger.V(2).Info("image is not from ACR, return empty authentication", "image", image)
@@ -259,7 +260,7 @@ func (a *acrProvider) GetCredentials(ctx context.Context, image string, _ []stri
 
 // getFromACR gets credentials from ACR.
 func (a *acrProvider) getFromACR(ctx context.Context, loginServer string) (string, string, error) {
-	logger := log.Background().WithName("getFromACR")
+	logger := log.FromContextOrBackground(ctx).WithName("getFromACR")
 	var armAccessToken azcore.AccessToken
 	var err error
 	if armAccessToken, err = a.credential.GetToken(ctx, policy.TokenRequestOptions{

pkg/credentialprovider/identity_bindings_credentials.go

@@ -136,7 +136,7 @@ func (c *identityBindingsTokenCredential) getTransport() (*http.Transport, error
 
 // GetToken retrieves an access token using identity bindings token exchange
 func (c *identityBindingsTokenCredential) GetToken(ctx context.Context, opts policy.TokenRequestOptions) (azcore.AccessToken, error) {
-	logger := log.Background().WithName("GetToken")
+	logger := log.FromContextOrBackground(ctx).WithName("GetToken")
 	// The scope should be exactly one value in format "https://management.azure.com/.default"
 	// or "https://containerregistry.azure.net/.default"
 	if len(opts.Scopes) != 1 {

pkg/nodeipam/ipam/cloud_cidr_allocator.go

@@ -266,7 +266,7 @@ func (ca *cloudCIDRAllocator) updateNodeSubnetMaskSizes(ctx context.Context, nod
 }
 
 func (ca *cloudCIDRAllocator) Run(ctx context.Context) {
-	logger := log.Background().WithName("Run")
+	logger := log.FromContextOrBackground(ctx).WithName("Run")
 	defer utilruntime.HandleCrash()
 
 	logger.Info("Starting cloud CIDR allocator")
@@ -353,7 +353,8 @@ func (ca *cloudCIDRAllocator) occupyCIDRs(node *v1.Node) error {
 // function you have to make sure to update nodesInProcessing properly with the
 // disposition of the node when the work is done.
 func (ca *cloudCIDRAllocator) AllocateOrOccupyCIDR(node *v1.Node) error {
-	logger := log.Background().WithName("AllocateOrOccupyCIDR")
+	ctx := context.Background()
+	logger := log.FromContextOrBackground(ctx).WithName("AllocateOrOccupyCIDR")
 	if node == nil || node.Spec.ProviderID == "" {
 		return nil
 	}
@@ -362,7 +363,7 @@ func (ca *cloudCIDRAllocator) AllocateOrOccupyCIDR(node *v1.Node) error {
 		return nil
 	}
 
-	err := ca.updateNodeSubnetMaskSizes(context.Background(), node.Name, node.Spec.ProviderID)
+	err := ca.updateNodeSubnetMaskSizes(ctx, node.Name, node.Spec.ProviderID)
 	if err != nil {
 		klog.Errorf("AllocateOrOccupyCIDR(%s): failed to update node subnet mask sizes: %v", node.Name, err)
 		return err

pkg/nodeipam/ipam/range_allocator.go

@@ -175,7 +175,7 @@ func NewCIDRRangeAllocator(client clientset.Interface, nodeInformer informers.No
 }
 
 func (r *rangeAllocator) Run(ctx context.Context) {
-	logger := log.Background().WithName("Run")
+	logger := log.FromContextOrBackground(ctx).WithName("Run")
 	defer utilruntime.HandleCrash()
 
 	logger.Info("Starting range CIDR allocator")

pkg/nodeipam/node_ipam_controller.go

@@ -190,7 +190,7 @@ func NewNodeIpamController(
 
 // Run starts an asynchronous loop that monitors the status of cluster nodes.
 func (nc *Controller) Run(ctx context.Context) {
-	logger := log.Background().WithName("Run")
+	logger := log.FromContextOrBackground(ctx).WithName("Run")
 	defer utilruntime.HandleCrash()
 
 	logger.Info("Starting ipam controller")

pkg/nodemanager/nodemanager.go

@@ -280,7 +280,7 @@ func (cnc *CloudNodeController) handleNodeEventWrapper(ctx context.Context, node
 
 // handleNodeEvent processes both add and update events for nodes that need cloud initialization
 func (cnc *CloudNodeController) handleNodeEvent(ctx context.Context, node *v1.Node) error {
-	logger := log.Background().WithName("handleNodeEvent")
+	logger := log.FromContextOrBackground(ctx).WithName("handleNodeEvent")
 	cloudTaint := GetCloudTaint(node.Spec.Taints)
 	if cloudTaint == nil {
 		logger.V(2).Info("Node has no cloud taint, skipping initialization", "nodeName", node.Name)
@@ -332,7 +332,7 @@ func (cnc *CloudNodeController) reconcileNodeLabels(node *v1.Node) error {
 
 // UpdateNodeAddress updates the nodeAddress of a single node
 func (cnc *CloudNodeController) updateNodeAddress(ctx context.Context, node *v1.Node) error {
-	logger := log.Background().WithName("updateNodeAddress")
+	logger := log.FromContextOrBackground(ctx).WithName("updateNodeAddress")
 	// Do not process nodes that are still tainted
 	cloudTaint := GetCloudTaint(node.Spec.Taints)
 	if cloudTaint != nil {
@@ -402,7 +402,7 @@ type nodeModifier func(*v1.Node)
 
 // This processes nodes that were added into the cluster, and cloud initialize them if appropriate
 func (cnc *CloudNodeController) initializeNode(ctx context.Context, node *v1.Node) error {
-	logger := log.Background().WithName("initializeNode")
+	logger := log.FromContextOrBackground(ctx).WithName("initializeNode")
 	logger.Info("Initializing node with cloud provider", "node", node.Name)
 	curNode, err := cnc.kubeClient.CoreV1().Nodes().Get(ctx, node.Name, metav1.GetOptions{})
 	if err != nil {

pkg/provider/azure.go

@@ -255,7 +255,7 @@ var (
 
 // InitializeCloudFromConfig initializes the Cloud from config.
 func (az *Cloud) InitializeCloudFromConfig(ctx context.Context, config *azureconfig.Config, _, callFromCCM bool) error {
-	logger := log.Background().WithName("InitializeCloudFromConfig")
+	logger := log.FromContextOrBackground(ctx).WithName("InitializeCloudFromConfig")
 	if config == nil {
 		// should not reach here
 		return fmt.Errorf("InitializeCloudFromConfig: cannot initialize from nil config")