🐛 let logr.Logger understand Kubernetes Object

[caozhuozi]

fixes: #1290
This addresses a long-standing bug.

An earlier attempt to fix this was made in #1883, but it hasn't received any reviews for a long time.

possible reasons include (in my opinion):

• The PR is quite old, and outdated pull requests often become less appealing for reviewers to pick up.
• The PR was relatively large and lacked detailed explanations of the changes, making it difficult to review.

To address this,

• I created a new PR.
• I simplified the original approach by minimizing the scope of changes and making the implementation easier to understand.

To summary the changes I made,

1. Introduced a dedicated simple helper package named logr, which just makes a logr.Logger aware of runtime.Object.
   (The need for a separate package and the naming are open for discussion.)
2. Applied this helper to wrap the logger created in zap.New().

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: caozhuozi
Once this PR has been reviewed and has the lgtm label, please assign sbueringer for approval. For more information see the 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

[k8s-ci-robot]

Hi @caozhuozi. 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-sigs/prow repository.

[alvaroaleman]

/ok-to-test

[alvaroaleman]

This change changes behavior ppl might rely on, so please mark it as breaking

[alvaroaleman]

This doesn't fully match the behavior of the KubeAwareEncoder, it only does the wrapping if its not set to Verbose:

controller-runtime/pkg/log/zap/kube_helpers.go

Lines 86 to 108 in 2a5cfa4

	if k.Verbose {
	// Kubernetes objects implement fmt.Stringer, so if we
	// want verbose output, just delegate to that.
	return k.Encoder.EncodeEntry(entry, fields)
	}
	for i, field := range fields {
	// intercept stringer fields that happen to be Kubernetes runtime.Object or
	// types.NamespacedName values (Kubernetes runtime.Objects commonly
	// implement String, apparently).
	// *unstructured.Unstructured does NOT implement fmt.Striger interface.
	// We have handle it specially.
	if field.Type == zapcore.StringerType || field.Type == zapcore.ReflectType {
	switch val := field.Interface.(type) {
	case runtime.Object:
	fields[i] = zapcore.Field{
	Type: zapcore.ObjectMarshalerType,
	Key: field.Key,
	Interface: kubeObjectWrapper{obj: val},
	}
	}
	}
	}

[alvaroaleman]

Why is this type exported?

[alvaroaleman]

Please describe the actual behavior here

[alvaroaleman]

Unless I am missing something, this fully obsoletes the need for the KubeAwareEncoder. If so, please delete it