⚠️ kube aware logger which could also work with logger.WithValues #1883

STRRL · 2022-05-03T07:42:31Z

Signed-off-by: STRRL im@strrl.dev

This PR could fix #1290

As this comment says, the latest logr provide logr.Marshaler, it could be used instead the current "kube-aware-logger-things" implementation with custom zap encoder

k8s-ci-robot · 2022-05-03T07:42:38Z

Welcome @STRRL!

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 · 2022-05-03T07:42:39Z

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

STRRL · 2022-05-03T10:34:27Z

Hi! I think this PR is ready for view.

/cc @timebertt

k8s-ci-robot · 2022-05-03T10:34:29Z

@STRRL: GitHub didn't allow me to request PR reviews from the following users: timebertt.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Hi! I think this PR is ready for view.

/cc @timebertt

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.

STRRL · 2022-07-13T06:26:50Z

PTAL

/cc @FillZpp

camilamacedo86 · 2022-07-16T06:49:38Z

examples/configfile/builtin/main.go

 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 )

 var scheme = runtime.NewScheme()

 func init() {
-	log.SetLogger(zap.New())
+	log.SetLogger(bootstrap.New())


It is a breaking change for those who are importing controller runtime.
Can you please use the emoji :warning: ?

Also, do we need to change the lib?

alvaroaleman · 2022-07-16T16:44:36Z

pkg/log/zap/zap.go

@@ -39,6 +39,7 @@ type NewEncoderFunc func(...EncoderConfigOption) zapcore.Encoder
 // New returns a brand new Logger configured with Opts. It
 // uses KubeAwareEncoder which adds Type information and
 // Namespace/Name to the log.
+// Deprecated: use bootstrap.New as instead.


What is the reason for moving things around? If anyhow possible, lets avoid this. All existing projects will need to be updated to get this fix, that is something we absolutely want to avoid.

What is the reason for moving things around?

I think using zap as the package name might bring confusion to users because we actually do not use zap.Logger but logr.Logger.

As the controller-runtime still stay with 0.x.x, I think maybe it would be friendly to introduce breaking changes right now rather than bring breaking changes after the stable 1.x.x. ❤️

If anyhow possible, lets avoid this.

I would make it a try! :D

alvaroaleman · 2022-07-16T16:45:27Z

/ok-to-test

Signed-off-by: STRRL <im@strrl.dev>

STRRL · 2022-07-17T03:12:37Z

Hi @alvaroaleman @camilamacedo86, I have updated the codes. It seems it would not change the API / bring the breaking changes now.

PTAL! ❤️

Could I remove the :warning: and change to use :bug: in the PR title?

STRRL · 2022-07-17T03:15:59Z

~~And CGO_ENABLED=1 make test failed on my local machine with unrelated testcases, could I ignore them?~~

It definitely failed cause by these changes in this PR ... I am going to take a look.

Signed-off-by: STRRL <im@strrl.dev>

STRRL · 2022-07-17T03:44:25Z

~~And CGO_ENABLED=1 make test failed on my local machine with unrelated testcases, could I ignore them?~~

It definitely failed cause by these changes in this PR ... I am going to take a look.

Fixed! PTAL! :D @alvaroaleman @camilamacedo86

STRRL · 2022-08-08T13:15:49Z

Hi @alvaroaleman @camilamacedo86, PTAL ❤️

STRRL · 2022-08-16T09:06:25Z

/cc @alvaroaleman @camilamacedo86 @FillZpp

STRRL · 2022-10-04T16:00:33Z

hi @alvaroaleman , could we push the progress of this PR

zbindenren · 2022-12-05T07:48:37Z

Maybe we should wait a little with logger changes before we see what happens whit this proposal. It is likely going to be accepted.

…ogger

k8s-ci-robot · 2022-12-06T05:47:55Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: STRRL
Once this PR has been reviewed and has the lgtm label, please assign gerred for approval by writing /assign @gerred in a comment. 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:

OWNERS

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

STRRL · 2022-12-06T05:49:52Z

Maybe we should wait a little with logger changes before we see what happens whit this proposal. It is likely going to be accepted.

It might still take a loooong time to use the new slog in the kubernetes ecosystem..

I am not sure it's worth waiting.

k8s-ci-robot · 2023-02-14T23:35:57Z

PR needs rebase.

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 · 2023-02-16T15:43:05Z

@STRRL: The following test 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-controller-runtime-test	`0e3754a`	link	true	`/test pull-controller-runtime-test`

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

k8s-triage-robot · 2023-05-17T16:35:12Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2023-06-16T17:12:52Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2023-07-16T17:35:34Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2023-07-16T17:35:38Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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 added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 3, 2022

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 May 3, 2022

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 3, 2022

k8s-ci-robot requested review from alenkacz and alvaroaleman May 3, 2022 07:42

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 3, 2022

STRRL marked this pull request as ready for review May 3, 2022 10:33

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 3, 2022

k8s-ci-robot requested a review from varshaprasad96 May 3, 2022 10:34

k8s-ci-robot requested a review from FillZpp July 13, 2022 06:26

camilamacedo86 reviewed Jul 16, 2022

View reviewed changes

alvaroaleman reviewed Jul 16, 2022

View reviewed changes

alvaroaleman added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jul 16, 2022

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 Jul 16, 2022

STRRL changed the title ~~🐛 kube aware logger which could also work with logger.WithValues~~ ⚠️ 🐛 kube aware logger which could also work with logger.WithValues Jul 17, 2022

STRRL changed the title ~~⚠️ 🐛 kube aware logger which could also work with logger.WithValues~~ ⚠️ kube aware logger which could also work with logger.WithValues Jul 17, 2022

STRRL force-pushed the kube-aware-logr-logger branch from 2268f75 to 42e1664 Compare July 17, 2022 03:02

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 17, 2022

STRRL force-pushed the kube-aware-logr-logger branch 2 times, most recently from da24bda to 521d348 Compare July 17, 2022 03:05

STRRL added 2 commits July 17, 2022 11:10

chore: replace zap.New with bootstrap.New

c288052

Signed-off-by: STRRL <im@strrl.dev>

chore: still using zap.New as the default logger bootstrapper

e4411c4

Signed-off-by: STRRL <im@strrl.dev>

STRRL force-pushed the kube-aware-logr-logger branch from 521d348 to e4411c4 Compare July 17, 2022 03:10

fix: fix testcases

705bd0c

Signed-off-by: STRRL <im@strrl.dev>

STRRL requested review from alvaroaleman and camilamacedo86 July 17, 2022 08:42

xrstf mentioned this pull request Jul 18, 2022

Make the KubeAwareEncoder less verbose kubermatic/kubermatic#10362

Closed

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 15, 2022

Merge remote-tracking branch 'upstream/master' into kube-aware-logr-l…

0e3754a

…ogger

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 6, 2022

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 14, 2023

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 17, 2023

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jun 16, 2023

k8s-ci-robot closed this Jul 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ kube aware logger which could also work with logger.WithValues #1883

⚠️ kube aware logger which could also work with logger.WithValues #1883

STRRL commented May 3, 2022 •

edited

Loading

k8s-ci-robot commented May 3, 2022

k8s-ci-robot commented May 3, 2022

STRRL commented May 3, 2022

k8s-ci-robot commented May 3, 2022

STRRL commented Jul 13, 2022

camilamacedo86 Jul 16, 2022

alvaroaleman Jul 16, 2022 •

edited

Loading

STRRL Jul 17, 2022

alvaroaleman commented Jul 16, 2022

STRRL commented Jul 17, 2022

STRRL commented Jul 17, 2022 •

edited

Loading

STRRL commented Jul 17, 2022

STRRL commented Aug 8, 2022

STRRL commented Aug 16, 2022

STRRL commented Oct 4, 2022

zbindenren commented Dec 5, 2022

k8s-ci-robot commented Dec 6, 2022

STRRL commented Dec 6, 2022

k8s-ci-robot commented Feb 14, 2023

k8s-ci-robot commented Feb 16, 2023

k8s-triage-robot commented May 17, 2023

k8s-triage-robot commented Jun 16, 2023

k8s-triage-robot commented Jul 16, 2023

k8s-ci-robot commented Jul 16, 2023

⚠️ kube aware logger which could also work with logger.WithValues #1883

⚠️ kube aware logger which could also work with logger.WithValues #1883

Conversation

STRRL commented May 3, 2022 • edited Loading

k8s-ci-robot commented May 3, 2022

k8s-ci-robot commented May 3, 2022

STRRL commented May 3, 2022

k8s-ci-robot commented May 3, 2022

STRRL commented Jul 13, 2022

camilamacedo86 Jul 16, 2022

Choose a reason for hiding this comment

alvaroaleman Jul 16, 2022 • edited Loading

Choose a reason for hiding this comment

STRRL Jul 17, 2022

Choose a reason for hiding this comment

alvaroaleman commented Jul 16, 2022

STRRL commented Jul 17, 2022

STRRL commented Jul 17, 2022 • edited Loading

STRRL commented Jul 17, 2022

STRRL commented Aug 8, 2022

STRRL commented Aug 16, 2022

STRRL commented Oct 4, 2022

zbindenren commented Dec 5, 2022

k8s-ci-robot commented Dec 6, 2022

STRRL commented Dec 6, 2022

k8s-ci-robot commented Feb 14, 2023

k8s-ci-robot commented Feb 16, 2023

k8s-triage-robot commented May 17, 2023

k8s-triage-robot commented Jun 16, 2023

k8s-triage-robot commented Jul 16, 2023

k8s-ci-robot commented Jul 16, 2023

STRRL commented May 3, 2022 •

edited

Loading

alvaroaleman Jul 16, 2022 •

edited

Loading

STRRL commented Jul 17, 2022 •

edited

Loading