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

Migrated server.go, ipvs/proxier.go(partial) to structured logging #105769

Merged

Conversation

shivanshuraj1333
Copy link
Contributor

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Fixed incorrectly migrated logs
Migrated some missing logs to structured logging

Which issue(s) this PR fixes:

Ref: #104872

Special notes for your reviewer:

In this PR, I've cleaned up some improperly migrated logs, going forward we need to figure out a way to make every migration follow the guide, #105718 (comment)
Also, this PR contains partial migration of ipvs/proxier.go since it's very huge file, sending another PR for remaining part

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-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 19, 2021
@k8s-ci-robot
Copy link
Contributor

@shivanshu1333: 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Oct 19, 2021
@k8s-ci-robot k8s-ci-robot added area/ipvs sig/network Categorizes an issue or PR as relevant to SIG Network. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 19, 2021
@shivanshuraj1333
Copy link
Contributor Author

/assign @serathius

shivanshuraj1333 and others added 5 commits October 19, 2021 22:34
Co-authored-by: Marek Siarkowicz <marek.siarkowicz@protonmail.com>
Co-authored-by: Marek Siarkowicz <marek.siarkowicz@protonmail.com>
Co-authored-by: Marek Siarkowicz <marek.siarkowicz@protonmail.com>
Co-authored-by: Marek Siarkowicz <marek.siarkowicz@protonmail.com>
Co-authored-by: Marek Siarkowicz <marek.siarkowicz@protonmail.com>
@shivanshuraj1333
Copy link
Contributor Author

/wg structured-logging
/area logging
/priority important-soon
/kind cleanup
/cc @kubernetes/wg-structured-logging-reviews

@k8s-ci-robot k8s-ci-robot added wg/structured-logging Categorizes an issue or PR as relevant to WG Structured Logging. area/logging priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 19, 2021
@serathius
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 19, 2021
@aojea
Copy link
Member

aojea commented Oct 19, 2021

@serathius for education, why replacing the .String() ?

@shivanshuraj1333
Copy link
Contributor Author

@aojea we don't need to use the stringer while logging, we do it by default in klog ref https://github.com/kubernetes/klog/blob/331d2323a192188a9aca7006c8dedd0c61c03833/klog.go#L816-L840

@shivanshuraj1333
Copy link
Contributor Author

/retest

@serathius
Copy link
Contributor

serathius commented Oct 20, 2021

@aojea This is a difference in behavior between C like format methods like "Infof" and structured ones like "InfoS".

In C string formats it is responsibility of log caller to decide how to marshal (represent as text/bytes) arguments passed to logger. For example you need to pick proper format "%d" for decimal numbers, for more complicated types like structs you can pick "%v", "%#v", "#+v" or implement stringer interface and use "%s". This allows users to have more control, however it leads to inconsistency throughout codebase.

In structured logging we explicitly delegate decision about marshalling to logging library, we pass whole object and depend on library to pick a best serialization methods (we can add some hints, but they should be applied per type and not per line). Good example is one that @shivanshu1333 linked https://github.com/kubernetes/klog/blob/331d2323a192188a9aca7006c8dedd0c61c03833/klog.go#L816-L840. It's the code that K8s uses to pick a marshalling when writing in default text format. However Kubernetes supports multiple log formats ("text", "json"), so best marshalling format will depend on logging format we use.

By removing .String() we avoid marshaling structs ourselfs and leave it to logging library. It should be able to pick best representation of the struct that we pass which can depend on external factors for example if user prefers logs in text or json.

@aojea
Copy link
Member

aojea commented Oct 20, 2021

Thanks both, appreciate it
/approve
we definitively need this structured logging linter running on presubmit :)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aojea, shivanshu1333

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 Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 20, 2021
@shivanshuraj1333
Copy link
Contributor Author

using label to squash
/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Oct 20, 2021
@k8s-ci-robot k8s-ci-robot merged commit d3f81a1 into kubernetes:master Oct 20, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.23 milestone Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/ipvs area/logging 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. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. release-note-none Denotes a PR that doesn't merit a release note. sig/network Categorizes an issue or PR as relevant to SIG Network. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. wg/structured-logging Categorizes an issue or PR as relevant to WG Structured Logging.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants