Migrate devicemanager to context logging (1/5) #132540

chuangw6 · 2025-06-25T21:37:08Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

migrate pkg/kubelet/cm/devicemanager to contextual logging

Which issue(s) this PR is related to:

#130069

Special notes for your reviewer:

This PR migrated:

pkg/kubelet/cm/devicemanager/plugin/v1beta1/client.go
pkg/kubelet/cm/devicemanager/plugin/v1beta1/handler.go
pkg/kubelet/cm/devicemanager/plugin/v1beta1/server.go
NewManagerImpl, Start and Stop in pkg/kubelet/cm/devicemanager/manager.go

Sorry for this PR's size. I fall down the rabbit hole of plumbing through context :<. I will migrate following files with smaller PRs:

pkg/kubelet/cm/devicemanager/manager.go
pkg/kubelet/cm/devicemanager/pod_devices.go
pkg/kubelet/cm/devicemanager/topology_hints.go
pkg/kubelet/cm/devicemanager/plugin/v1beta1/stub.go

Does this PR introduce a user-facing change?

NONE

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

linux-foundation-easycla · 2025-06-25T21:37:16Z

The committers listed above are authorized under a signed CLA.

✅ login: chuangw6 / name: Chuang Wang (40c6a0a)

k8s-ci-robot · 2025-06-25T21:37:17Z

Welcome @chuangw6!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-06-25T21:37:17Z

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-06-25T21:37:18Z

Hi @chuangw6. Thanks for your PR.

I'm waiting for a kubernetes 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.

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.

yujuhong · 2025-06-25T22:22:18Z

/ok-to-test

pkg/kubelet/cm/devicemanager/manager.go

chuangw6 · 2025-06-26T22:09:55Z

/retest

k8s-ci-robot · 2025-06-27T01:38:12Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: chuangw6
Once this PR has been reviewed and has the lgtm label, please assign random-liu, saad-ali 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:

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

ffromani

thanks for the PR! I'm generally very supportive of moving to contextual logging (and my own effort starved). I expect a somehow long tail of tuning and refinements after the initial plumbing lands, but by all means let's get the plumbing merged before!
Some comments inside

ffromani · 2025-06-27T06:47:45Z

pkg/kubelet/cm/devicemanager/plugin/v1beta1/client.go

+	Connect(ctx context.Context) error
+	Run(ctx context.Context)
+	Disconnect(ctx context.Context) error


not sure we can just the method signature of the interface, will check

pkg/kubelet/cm/devicemanager/types.go

ffromani · 2025-06-27T06:49:57Z

pkg/kubelet/cm/dra/plugin/dra_plugin_manager.go

@@ -307,7 +307,7 @@ func (pm *DRAPluginManager) get(driverName string) *DRAPlugin {
 // name>" format (e.g. "v1beta1.DRAPlugin"). This allows kubelet to determine
 // in advance which version to use resp. which optional services the plugin
 // supports.
-func (pm *DRAPluginManager) RegisterPlugin(driverName string, endpoint string, supportedServices []string, pluginClientTimeout *time.Duration) error {
+func (pm *DRAPluginManager) RegisterPlugin(_ context.Context, driverName string, endpoint string, supportedServices []string, pluginClientTimeout *time.Duration) error {


uhm, devicemanager is not related to DRA. Why do we want to update also DRA code?

see #132540 (comment)

@chuangw6 Would it be possible to avoid changing pluginmanager interface until it's moved to contextual logging? This should reduce amount of changes in this PR, I guess.
BTW, pluginmanager move is addressed by this pr.

can look into it when I am back to office (Thursday and Friday are U.S. holidays). A couple of questions:

#130376 doesn't plumb context to the interface in pkg/kubelet/pluginmanager/cache/types.go (validate, register, deregister), but the interface is used at many places as you may see in this PR including

pkg/kubelet/cm/devicemanager/plugin/v1beta1/handler.go

pkg/kubelet/pluginmanager/operationexecutor/operation_generator.go

pkg/volume/csi/csi_plugin.go

I can ignore the last 2, but pkg/kubelet/cm/devicemanager/plugin/v1beta1/handler.go is under the scope for migrating to context logging. Are you okay with using context.TODO() instead of plumbing ctx for that file?

Circulating back to your comments in #132583, it's unclear to me what migration approach you are looking for. Seems like you're okay with this 1/5 PR except pluginmanager thing, but this 1/5 PR just migrates a portion of devicemanager. And there are so much more to migrate as described in the PR description. So can you please clarify what approach you are looking for for migrating other files in devicemanager if file-by-file approach is not ideal?

I can ignore the last 2, but pkg/kubelet/cm/devicemanager/plugin/v1beta1/handler.go is under the scope for migrating to context logging. Are you okay with using context.TODO() instead of plumbing ctx for that file?

I'm ok with using context.TODO() with a comment explaining when and how it's going to be replaced with a proper context.

So can you please clarify what approach you are looking for for migrating other files in devicemanager if file-by-file approach is not ideal?

So far it was one PR for one component. You can see current migration status in the description of the issue #130069. If component is too big it makes sense to migrate it by more than one PR, but definitely not by one PR per file.

BTW, the approach is explained in the issue as well. If there is something not clear, please suggest better description.

pkg/kubelet/pluginmanager/cache/types.go

ffromani · 2025-06-27T06:51:01Z

pkg/volume/csi/csi_plugin.go

-func (h *RegistrationHandler) ValidatePlugin(pluginName string, endpoint string, versions []string) error {
-	klog.Info(log("Trying to validate a new CSI Driver with name: %s endpoint: %s versions: %s",
-		pluginName, endpoint, strings.Join(versions, ",")))
+func (h *RegistrationHandler) ValidatePlugin(ctx context.Context, pluginName string, endpoint string, versions []string) error {


likewise, are updating all plugins in one go or just device manager?

My goal was to just update device manager, but to migrate pkg/kubelet/cm/devicemanager/plugin/v1beta1/handler.go, the PluginHandler interface in pkg/kubelet/pluginmanager/cache/types.go needs to be updated. Otherwise, type check will fail. This led to a series of cascading changes.

chuangw6 · 2025-06-30T21:40:46Z

nolint:errcheck

chuangw6 · 2025-06-30T21:41:17Z

/test pull-kubernetes-linter-hints

chuangw6 · 2025-06-30T21:50:57Z

/test pull-kubernetes-node-e2e-containerd

k8s-ci-robot · 2025-06-30T22:02:50Z

@chuangw6: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-kubernetes-linter-hints	`40c6a0a`	link	false	`/test pull-kubernetes-linter-hints`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

ffromani · 2025-07-01T13:06:21Z

General note about migration to contextual logging. There are quite few areas where we can use or should use more contexts; that's fine. In general however just passing context around for the sake of using the logger instance (because this is only the legit use of the context in such cases) seems suboptimal.
Plus, we don't use WithName or WithValues a lot, which is the real place where the contextual logging really adds value.
In this case it seems awkward to me to do the FromContext/NewContext dance when we can "just" pass around the logger instance.
I guess we can do a sweeping change in general and then refine in the later versions once we gain more confidence and we learn better the usages of the logger.
TL;DR: I'm ok doing the change in waves (sweeping waves), this will be the first of quite a few.

chuangw6 · 2025-07-01T19:10:24Z

@ffromani Generally I agree with you, but it's tough to know if a function will need a context later or just a logger. If we only pass a logger and it ends up needing a context, that's an issue.
So, you're cool with passing context around for now? If so, can you approve the PR if there's no other feedback? Lmk otherwise.

ffromani · 2025-07-02T06:26:44Z

@ffromani Generally I agree with you, but it's tough to know if a function will need a context later or just a logger. If we only pass a logger and it ends up needing a context, that's an issue. So, you're cool with passing context around for now? If so, can you approve the PR if there's no other feedback? Lmk otherwise.

As general approach to move to contextual logging, we can either very carefully review ewach and every PR and try to anticipate needs, adding context in the logs and evaluate on a case-by-case basis where we can use what, or do a series of sweeping changes. E.g.

add context everywhere (this approach)
review usage and change internal APIs to get loggers vs contexts
review usage and change adding data to context, looking at the flows and call chains

I'm ok with a series of sweeping changes, so I'm ok with the general direction of this PR. We will review again. Please make sure to make and keep CI happy.

k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jun 25, 2025

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 25, 2025

k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 25, 2025

k8s-ci-robot requested review from derekwaynecarr and ffromani June 25, 2025 21:37

k8s-ci-robot added area/kubelet sig/node Categorizes an issue or PR as relevant to SIG Node. labels Jun 25, 2025

github-project-automation bot added this to SIG Node: code and documentation PRs Jun 25, 2025

github-project-automation bot moved this to Triage in SIG Node: code and documentation PRs Jun 25, 2025

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 25, 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 Jun 25, 2025

SergeyKanzhelev reviewed Jun 25, 2025

View reviewed changes

pkg/kubelet/cm/devicemanager/manager.go Show resolved Hide resolved

k8s-ci-robot added the wg/device-management Categorizes an issue or PR as relevant to WG Device Management. label Jun 25, 2025

github-project-automation bot added this to Dynamic Resource Allocation Jun 25, 2025

github-project-automation bot moved this to 🆕 New in Dynamic Resource Allocation Jun 25, 2025

chuangw6 force-pushed the ctx-log branch 2 times, most recently from 2986644 to 36d6bfa Compare June 25, 2025 23:33

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. labels Jun 26, 2025

chuangw6 reopened this Jun 26, 2025

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 26, 2025

github-project-automation bot moved this from Done to Triage in SIG Node: code and documentation PRs Jun 26, 2025

chuangw6 force-pushed the ctx-log branch 4 times, most recently from 4eea21f to b32e789 Compare June 27, 2025 01:37

ffromani reviewed Jun 27, 2025

View reviewed changes

chuangw6 force-pushed the ctx-log branch from b32e789 to cac6c34 Compare June 27, 2025 18:01

Migrate devicemanager to context logging

40c6a0a

chuangw6 force-pushed the ctx-log branch from cac6c34 to 40c6a0a Compare June 30, 2025 21:20

chuangw6 changed the title ~~(WIP) Migrate devicemanager to context logging (1/5)~~ Migrate devicemanager to context logging (1/5) Jun 30, 2025

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 30, 2025

chuangw6 requested review from tallclair and ffromani June 30, 2025 21:28

chuangw6 mentioned this pull request Jul 1, 2025

Migrate devicemanager to context logging (2/5) #132583

Open

bart0sh mentioned this pull request Jul 2, 2025

Migrate Kubelet codebase to contextual logging #130069

Open

50 tasks

Migrate devicemanager to context logging (1/5) #132540

Are you sure you want to change the base?

Migrate devicemanager to context logging (1/5) #132540

Conversation

chuangw6 commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR is related to:

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!

linux-foundation-easycla bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Jun 25, 2025

Uh oh!

k8s-ci-robot commented Jun 25, 2025

Uh oh!

k8s-ci-robot commented Jun 25, 2025

Uh oh!

yujuhong commented Jun 25, 2025

Uh oh!

Uh oh!

chuangw6 commented Jun 26, 2025

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

ffromani left a comment

Choose a reason for hiding this comment

Uh oh!

ffromani Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ffromani Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

chuangw6 Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

bart0sh Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

chuangw6 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

bart0sh Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ffromani Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

chuangw6 Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chuangw6 commented Jun 30, 2025

Uh oh!

chuangw6 commented Jun 30, 2025

Uh oh!

chuangw6 commented Jun 30, 2025

Uh oh!

k8s-ci-robot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ffromani commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chuangw6 commented Jul 1, 2025

Uh oh!

ffromani commented Jul 2, 2025

Uh oh!

Uh oh!

chuangw6 commented Jun 25, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jun 25, 2025 •

edited

Loading

chuangw6 Jun 27, 2025 •

edited

Loading

k8s-ci-robot commented Jun 30, 2025 •

edited

Loading

ffromani commented Jul 1, 2025 •

edited

Loading