✨ Surface API Server warnings in client #1468

MadhavJivrajani · 2021-04-04T07:10:30Z

Add a WarningHandler that writes to stderr
- Deduplicates warnings
- Highlight warning output with color when the outut supports it

/hold
/cc joelanford

Currently, by default warnings are surfaced, should an option be provided to turn off the warnings if needed as illustrated here?

k8s-ci-robot · 2021-04-04T07:10:37Z

Welcome @MadhavJivrajani!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. 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-sigs/controller-runtime 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 · 2021-04-04T07:10:38Z

Hi @MadhavJivrajani. Thanks for your PR.

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

alvaroaleman

/ok-to-test

pkg/client/client.go

- Add a wrapper around `logr.Logger` that implements WarnignHandler - Add options in client.go for settiing up behaviour of warning handler Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>

MadhavJivrajani · 2021-04-11T14:18:35Z

/hold cancel

pkg/client/client.go

pkg/log/warning_handler.go

pkg/client/client.go

pkg/log/warning_handler.go

alvaroaleman · 2021-04-11T15:02:10Z

pkg/client/client.go

+				Deduplicate: !options.Opts.AllowDuplicateLogs,
+			},
+		),
+	)


I am wondering a bit if the client is the best place to plug this in. Maybe pkg/cluster would be better? Or both?
Many ppl will use the cache-backed client and all its read operations will not have this enabled since they go through the cache.
cc @vincepri

Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>

alvaroaleman · 2021-04-12T21:47:31Z

pkg/log/warning_handler.go

+		}
+		l.written[message] = struct{}{}
+	}
+	l.logger.Info(message)


Suggested change

l.logger.Info(message)

l.logger.Warn(message)

One clarification: if I understand correctly, the logr.Logger interface doesn't implement a Warn level and instead recommends specifying verbosity levels for Info logs itself as explained here, so maybe setting a verbosity level using V or using coloured output for the Info messages that come out of the API Warning Logger?

I see, lets keep it at Info then

alvaroaleman

/lgtm
/approve

Thanks for your work!

k8s-ci-robot · 2021-04-13T12:57:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, MadhavJivrajani

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:

~~OWNERS~~ [alvaroaleman]

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

MadhavJivrajani · 2021-04-13T13:06:37Z

Thanks so much for the constant feedback @alvaroaleman! I had a great time working on this 😄

* Surface API Server warnings in client - Add a wrapper around `logr.Logger` that implements WarnignHandler - Add options in client.go for settiing up behaviour of warning handler Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com> * rename logger type Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>

k8s-ci-robot requested a review from joelanford April 4, 2021 07:10

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 4, 2021

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 Apr 4, 2021

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 4, 2021

alvaroaleman reviewed Apr 4, 2021

View reviewed changes

pkg/client/client.go Outdated Show resolved Hide resolved

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 Apr 4, 2021

MadhavJivrajani requested a review from alvaroaleman April 8, 2021 10:38

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 8, 2021

Surface API Server warnings in client

9ab81e9

- Add a wrapper around `logr.Logger` that implements WarnignHandler - Add options in client.go for settiing up behaviour of warning handler Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 11, 2021

alvaroaleman reviewed Apr 11, 2021

View reviewed changes

rename logger type

3745f1d

Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>

alvaroaleman reviewed Apr 12, 2021

View reviewed changes

alvaroaleman added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Apr 13, 2021

alvaroaleman approved these changes Apr 13, 2021

View reviewed changes

k8s-ci-robot assigned alvaroaleman Apr 13, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 13, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 13, 2021

k8s-ci-robot merged commit 7ef2da0 into kubernetes-sigs:master Apr 13, 2021

k8s-ci-robot added this to the v0.9.x milestone Apr 13, 2021

MadhavJivrajani mentioned this pull request May 11, 2021

REQUEST: New membership for @MadhavJivrajani kubernetes/org#2705

Closed

6 tasks

ash2k mentioned this pull request Jun 9, 2022

Client creation sets a global warning handler by default #1928

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Surface API Server warnings in client #1468

✨ Surface API Server warnings in client #1468

MadhavJivrajani commented Apr 4, 2021 •

edited

Loading

k8s-ci-robot commented Apr 4, 2021

k8s-ci-robot commented Apr 4, 2021

alvaroaleman left a comment

MadhavJivrajani commented Apr 11, 2021

alvaroaleman Apr 11, 2021

alvaroaleman Apr 12, 2021

MadhavJivrajani Apr 13, 2021 •

edited

Loading

alvaroaleman Apr 13, 2021

alvaroaleman left a comment

k8s-ci-robot commented Apr 13, 2021

MadhavJivrajani commented Apr 13, 2021

✨ Surface API Server warnings in client #1468

✨ Surface API Server warnings in client #1468

Conversation

MadhavJivrajani commented Apr 4, 2021 • edited Loading

k8s-ci-robot commented Apr 4, 2021

k8s-ci-robot commented Apr 4, 2021

alvaroaleman left a comment

Choose a reason for hiding this comment

MadhavJivrajani commented Apr 11, 2021

alvaroaleman Apr 11, 2021

Choose a reason for hiding this comment

alvaroaleman Apr 12, 2021

Choose a reason for hiding this comment

MadhavJivrajani Apr 13, 2021 • edited Loading

Choose a reason for hiding this comment

alvaroaleman Apr 13, 2021

Choose a reason for hiding this comment

alvaroaleman left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 13, 2021

MadhavJivrajani commented Apr 13, 2021

MadhavJivrajani commented Apr 4, 2021 •

edited

Loading

MadhavJivrajani Apr 13, 2021 •

edited

Loading