Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

client-go auth: contextual logging #129336

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

client-go auth: contextual logging #129336

wants to merge 1 commit into from
+7 −1

Conversation

pohly
Copy link
Contributor

@pohly pohly commented Dec 20, 2024

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Part of #129125

Special notes for your reviewer:

No API changes are needed. In one case, a context is passed in via the http.Request. In others there is simply no need to change the calls.

Does this PR introduce a user-facing change?

NONE

/wg structured-logging

@pohly
client-go auth: contextual logging
a392191 
No API changes are needed. In one case, a context is passed in via the
http.Request. In others there is simply no need to change the calls.
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. wg/structured-logging Categorizes an issue or PR as relevant to WG Structured Logging. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 20, 2024
@k8s-ci-robot
Copy link
Contributor

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 k8s-ci-robot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Dec 20, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pohly
Once this PR has been reviewed and has the lgtm label, please assign mikedanese for approval. For more information see the Kubernetes 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

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/auth Categorizes an issue or PR as relevant to SIG Auth. labels Dec 20, 2024
enj
enj suggested changes Dec 20, 2024
View reviewed changes
staging/src/k8s.io/client-go/plugin/pkg/client/auth/exec/metrics.go
Comment on lines +108 to 109
//nolint:logcheck // This looks like debug output which shouldn't occur in practice.
klog.V(2).InfoS("unexpected exec plugin return error type", "type", reflect.TypeOf(err).String(), "err", err)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we update this instead of ignoring?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can update to structured logging, but doing contextual logging didn't seem worth the chain of API changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, it is already using structured logging. The suppression is for the "contextual logging" aspect.

I can rewrite as klog.Background().V(2).Info instead of suppressing the linter, but proper conversion (= avoiding the global logger) probably isn't worth it.

staging/src/k8s.io/client-go/plugin/pkg/client/auth/oidc/oidc.go
Comment on lines +129 to 130
//nolint:logcheck // Should not happen.
klog.V(2).Infof("%s auth provider field depricated, refresh request don't send scopes",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can totally happen so we should update it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But only if used incorrectly, right?

Do you prefer structured logging here?

@pohly
Copy link
Contributor Author

pohly commented Dec 20, 2024

/test pull-kubernetes-e2e-gce

"failed to create fsnotify watcher: too many open files"

pohly added a commit to pohly/kubernetes that referenced this pull request Dec 20, 2024
@pohly
merge log-client-go-auth (kubernetes#129336)
4d1a4d8
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Dec 20, 2024 •
edited
Loading

@pohly: The following tests 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-e2e-capz-azure-disk-windows a392191 link false /test pull-kubernetes-e2e-capz-azure-disk-windows
pull-kubernetes-e2e-capz-azure-file-vmss a392191 link false /test pull-kubernetes-e2e-capz-azure-file-vmss
pull-kubernetes-e2e-capz-azure-disk-vmss a392191 link false /test pull-kubernetes-e2e-capz-azure-disk-vmss

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@enj enj enj requested changes

@mikedanese mikedanese Awaiting requested review from mikedanese

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/auth Categorizes an issue or PR as relevant to SIG Auth. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. wg/structured-logging Categorizes an issue or PR as relevant to WG Structured Logging.
Projects
SIG Auth
Status: Changes Requested
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pohly @k8s-ci-robot @enj