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.

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

Migrate pkg/kubelet/config to structured logging #100002

Merged
merged 1 commit into from Mar 15, 2021

Conversation

AfrouzMashayekhi
Copy link
Contributor

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 9, 2021

What type of PR is this?

/kind cleanup
/sig instrumentation
/sig node
/priority important-soon

What this PR does / why we need it:

Migrate pkg/kubelet/config to structured logging

Which issue(s) this PR fixes:

Ref #98976

Special notes for your reviewer:

part of kubernetes/enhancements#1602
As it is related to log, change the log here to structured log.

Does this PR introduce a user-facing change?

NONE

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


@k8s-ci-robot k8s-ci-robot added release-note kind/cleanup size/M sig/instrumentation sig/node cncf-cla: yes priority/important-soon needs-triage needs-ok-to-test labels Mar 9, 2021
@k8s-ci-robot
Copy link
Contributor

@k8s-ci-robot k8s-ci-robot commented Mar 9, 2021

Hi @AfrouzMashayekhi. 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/test-infra repository.

@AfrouzMashayekhi
Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 9, 2021

/cc @serathius

@k8s-ci-robot k8s-ci-robot requested a review from serathius Mar 9, 2021
@shubheksha
Copy link
Contributor

@shubheksha shubheksha commented Mar 9, 2021

Hey @AfrouzMashayekhi, we normally don't use full stops after error messages. Logging both the object and the specific info about the same object seems repetitive. I'd also advice not modifying the error messages too much unless to clarify them further. If you could address this across your PR, I'm happy to take another look.

@AfrouzMashayekhi
Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 9, 2021

@shubheksha hope it's ok now

@@ -102,7 +102,7 @@ func (s *sourceFile) doWatch() error {
func (s *sourceFile) produceWatchEvent(e *fsnotify.Event) error {
// Ignore file start with dots
if strings.HasPrefix(filepath.Base(e.Name), ".") {
klog.V(4).Infof("Ignored pod manifest: %s, because it starts with dots", e.Name)
klog.V(4).InfoS("Ignored pod manifest, because it starts with dots", "event", e.Name)
Copy link
Contributor

@shubheksha shubheksha Mar 9, 2021

Choose a reason for hiding this comment

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

This is missing an "eventName" key

pkg/kubelet/config/http.go Outdated Show resolved Hide resolved
pkg/kubelet/config/file.go Outdated Show resolved Hide resolved
pkg/kubelet/config/file.go Show resolved Hide resolved
pkg/kubelet/config/file.go Outdated Show resolved Hide resolved
pkg/kubelet/config/file.go Outdated Show resolved Hide resolved
pkg/kubelet/config/config.go Outdated Show resolved Hide resolved

if pod.Namespace == "" {
pod.Namespace = metav1.NamespaceDefault
}
klog.V(5).Infof("Using namespace %q for pod %q from %s", pod.Namespace, pod.Name, source)
klog.V(5).InfoS("Used namespace for pod from source", "pod", klog.KObj(pod), "source", source)

Copy link
Contributor

@shubheksha shubheksha Mar 9, 2021

Choose a reason for hiding this comment

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

Why are we logging the full object here?

Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi Mar 9, 2021

Choose a reason for hiding this comment

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

In the KEP guide said we should reference Kubernetes objects.

Copy link
Contributor

@serathius serathius Mar 9, 2021

Choose a reason for hiding this comment

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

klog.KObj doesn't log whole object, just a reference in standard format <namespace>/<name>. Main reason for using it is it both supports text and json format.

pkg/kubelet/config/config.go Outdated Show resolved Hide resolved
pkg/kubelet/config/config.go Outdated Show resolved Hide resolved
pkg/kubelet/config/file.go Outdated Show resolved Hide resolved
@@ -254,16 +254,16 @@ func (s *podStorage) merge(source string, change interface{}) (adds, updates, de
switch update.Op {
case kubetypes.ADD, kubetypes.UPDATE, kubetypes.DELETE:
if update.Op == kubetypes.ADD {
klog.V(4).Infof("Adding new pods from source %s : %v", source, update.Pods)
klog.V(4).InfoS("Added new pods from source", "source", source, "pods", update.Pods)
Copy link
Contributor

@serathius serathius Mar 9, 2021

Choose a reason for hiding this comment

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

Could you use format.Pods from #99799

@k8s-ci-robot k8s-ci-robot added ok-to-test triage/accepted and removed needs-ok-to-test needs-triage labels Mar 10, 2021
@ehashman ehashman moved this from Triage to Waiting on Author in SIG Node PR Triage Mar 10, 2021
@AfrouzMashayekhi
Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 10, 2021

/test pull-kubernetes-node-e2e

@AfrouzMashayekhi
Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 10, 2021

/retest

Co-authored-by: Shubheksha <shubheksha@users.noreply.github.com>

Co-authored-by: Marek Siarkowicz <marek.siarkowicz@protonmail.com>

Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
@AfrouzMashayekhi
Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 11, 2021

/retest

1 similar comment
@AfrouzMashayekhi
Copy link
Contributor Author

@AfrouzMashayekhi AfrouzMashayekhi commented Mar 11, 2021

/retest

@kikisdeliveryservice kikisdeliveryservice moved this from Waiting on Author to Needs Reviewer in Structured Logging Migration for Kubelet, 1.21 Mar 11, 2021
@kikisdeliveryservice kikisdeliveryservice moved this from Waiting on Author to Needs Reviewer in SIG Node PR Triage Mar 11, 2021
Copy link
Member

@kikisdeliveryservice kikisdeliveryservice left a comment

Verified requested changes made, review changes, checked files for completeness. Passing this to approvers

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm label Mar 11, 2021
@kikisdeliveryservice kikisdeliveryservice moved this from Needs Reviewer to Needs Approver in Structured Logging Migration for Kubelet, 1.21 Mar 11, 2021
@kikisdeliveryservice kikisdeliveryservice moved this from Needs Reviewer to Needs Approver in SIG Node PR Triage Mar 11, 2021
@ehashman
Copy link
Member

@ehashman ehashman commented Mar 11, 2021

/milestone v1.21

@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Mar 11, 2021
@k8s-ci-robot
Copy link
Contributor

@k8s-ci-robot k8s-ci-robot commented Mar 15, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AfrouzMashayekhi, mrunalp

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

The pull request process is described 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 the approved label Mar 15, 2021
@mrunalp mrunalp moved this from Needs Approver to Done in Structured Logging Migration for Kubelet, 1.21 Mar 15, 2021
@k8s-ci-robot k8s-ci-robot merged commit f18caa8 into kubernetes:master Mar 15, 2021
14 checks passed
SIG Node PR Triage automation moved this from Needs Approver to Done Mar 15, 2021
@k8s-ci-robot k8s-ci-robot added release-note-none and removed release-note labels Mar 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/kubelet cncf-cla: yes kind/cleanup lgtm ok-to-test priority/important-soon release-note-none sig/instrumentation sig/node size/M triage/accepted
Development

Successfully merging this pull request may close these issues.

None yet

7 participants