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

Migrated pkg/proxy to structured logging #104891

Merged
merged 15 commits into from
Oct 14, 2021
Merged

Migrated pkg/proxy to structured logging #104891

merged 15 commits into from
Oct 14, 2021

Conversation

shivanshuraj1333
Copy link
Contributor

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Migrate pkg/proxy to structured logging

Which issue(s) this PR fixes:

Fixes #
Ref #104872

Special notes for your reviewer:

Does this PR introduce a user-facing change?

migrated pkg/proxy to structured logging

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

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 10, 2021
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not 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 Sep 10, 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
Copy link
Contributor

Welcome @shivanshu1333!

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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Sep 10, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @shivanshu1333. 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.

@k8s-ci-robot k8s-ci-robot requested review from aojea and bowei September 10, 2021 06:36
@k8s-ci-robot k8s-ci-robot added 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 Sep 10, 2021
@shivanshuraj1333
Copy link
Contributor Author

I signed it

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 10, 2021
@shivanshuraj1333 shivanshuraj1333 marked this pull request as draft September 10, 2021 07:02
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 10, 2021
@shivanshuraj1333 shivanshuraj1333 mentioned this pull request Sep 10, 2021
Closed
@aojea
Copy link
Member

aojea commented Sep 10, 2021

once you have it ready for review please undraft the PR
/ok-to-test

@k8s-ci-robot 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 Sep 10, 2021
@shivanshuraj1333
Copy link
Contributor Author

Yes, sure

@shivanshuraj1333
Copy link
Contributor Author

/retest-required

@pacoxu
Copy link
Member

pacoxu commented Sep 10, 2021 •
edited
Loading

Here is the guide, https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#remove-string-formatting-from-log-message
I find the log is not started with a capital letter in the pr.

Additionally we can improve messages to comply with good practices:

  • Start from a capital letter.
  • Do not end the message with a period.
  • Use active voice. Use complete sentences when there is an acting subject ("A could not do B") or omit the subject if the subject would be the program itself ("Could not do B").
  • Use past tense ("Could not delete B" instead of "Cannot delete B")
  • When referring to an object, state what type of object it is. ("Deleted pod" instead of "Deleted")

@shivanshuraj1333
Copy link
Contributor Author

Alright sure will update it.

serathius
serathius reviewed Sep 30, 2021
View reviewed changes
pkg/proxy/endpoints.go Outdated Show resolved Hide resolved
serathius
serathius reviewed Sep 30, 2021
View reviewed changes
pkg/proxy/service.go Outdated Show resolved Hide resolved
serathius
serathius reviewed Sep 30, 2021
View reviewed changes
pkg/proxy/service.go Outdated Show resolved Hide resolved
serathius
serathius reviewed Sep 30, 2021
View reviewed changes
pkg/proxy/endpoints.go Outdated Show resolved Hide resolved
@serathius
Copy link
Contributor

Please don't call .String() when passing arguments to logging. Logging library will decide how to marshall the object itself. For example it will call .String() itself when "text" logging format is enabled, however when json format is enabled it can improve serialization by using JSON.

@shivanshuraj1333
Copy link
Contributor Author

Okay, understood!

@shivanshuraj1333
Copy link
Contributor Author

/retest

2 similar comments
@serathius
Copy link
Contributor

/retest

@shivanshuraj1333
Copy link
Contributor Author

/retest

@spiffxp
Copy link
Member

spiffxp commented Sep 30, 2021

/test pull-kubernetes-node-e2e-containerd
ref: #105381

@shivanshuraj1333
Copy link
Contributor Author

/test pull-kubernetes-node-e2e-containerd

@serathius
Copy link
Contributor

/lgtm

@serathius
Copy link
Contributor

ping @dcbw

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

pinging @thockin for suggestions/approval
Thanks!

@serathius
Copy link
Contributor

/cc @dims

@k8s-ci-robot k8s-ci-robot requested a review from dims October 14, 2021 15:08
@dims
Copy link
Member

dims commented Oct 14, 2021

/assign @aojea

@aojea
Copy link
Member

aojea commented Oct 14, 2021

/approve
I see Tim's comments were addresses
Thanks

@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 14, 2021
@k8s-ci-robot k8s-ci-robot merged commit daf5af2 into kubernetes:master Oct 14, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.23 milestone Oct 14, 2021
tallclair pushed a commit to tallclair/kubernetes that referenced this pull request Oct 26, 2021
@shivanshuraj1333 @tallclair
Migrated pkg/proxy to structured logging (kubernetes#104891)
113b663 
* migrated service.go to structured logging

* fixing capital letter in starting

* migrated topology.go

* migrated endpointslicecache.go

* migrated endpoints.go

* nit typo

* nit plural to singular

* fixed format

* code formatting

* resolving review comment for key ipFamily

* resolving review comment for key endpoints.go

* code formating

* Converted Warningf to ErrorS, wherever applicable

* included review changes

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

@aojea aojea aojea left review comments

@serathius serathius serathius left review comments

@thockin thockin thockin left review comments

@bowei bowei Awaiting requested review from bowei

@johnbelamaric johnbelamaric Awaiting requested review from johnbelamaric

@yangjunmyfm192085 yangjunmyfm192085 Awaiting requested review from yangjunmyfm192085

@dims dims Awaiting requested review from dims

Assignees

@serathius serathius

@aojea aojea

@dcbw dcbw

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. release-note Denotes a PR that will be considered when it comes time to generate release notes. 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
Milestone
v1.23
Development

Successfully merging this pull request may close these issues.