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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃尡 ClusterClass: improve logging #5751

Merged
merged 1 commit into from
Nov 30, 2021

Conversation

sbueringer
Copy link
Member

Signed-off-by: Stefan B眉ringer buringerst@vmware.com

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Signed-off-by: Stefan B眉ringer buringerst@vmware.com
@@ -78,7 +78,7 @@ type TemplateRef struct {
MachineDeploymentRef MachineDeploymentRef
}

func (t *TemplateRef) String() string {
func (t TemplateRef) String() string {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like the String func should always be implemented with a value receiver. That way it works independent of if the TemplateRef is a pointer or not (I tested it with ~ fmt.Sprintf("%s %s", &api.TemplateRef{..}, api.TemplateRef{..})

This leads to the question if we should fix it in other cases too:

  • func (n *Node) String() string {

    • exported type in test/infrastructure/docker/docker/types
  • func (p *ProviderID) String() string {

    • exported type in controllers/noderefutil
  • func (n *NetworkRanges) String() string {

    • exported type in api/v1beta1
  • func (t *healthCheckTarget) string() string {

    • Just saw that one is lower case so it doesn't implement the interface anyway

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's open an issue for this

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done: #5755

@@ -248,7 +248,7 @@ func applyPatchesToRequest(ctx context.Context, req *api.GenerateRequest, resp *
log := tlog.LoggerFrom(ctx)

for _, patch := range resp.Items {
log = log.WithValues("templateRef", patch.TemplateRef)
log = log.WithValues("templateRef", patch.TemplateRef.String())
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to call the .String() func here explicitly because WithValues (and its underlying funcs) does not automatically use String() if the type implements the Stringer interface like fmt.Sprintf does

@fabriziopandini
Copy link
Member

/lgtm

@k8s-triage-robot
Copy link

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 29, 2021
@sbueringer
Copy link
Member Author

/check-cla

Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 30, 2021
@sbueringer
Copy link
Member Author

sbueringer commented Nov 30, 2021

@fabriziopandini Can you please reapply the lgtm label? Looks like Prow didn't set it based on your comment

/retest

@fabriziopandini
Copy link
Member

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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 merged commit 0fb3192 into kubernetes-sigs:main Nov 30, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Nov 30, 2021
@sbueringer sbueringer deleted the pr-impro-cc-logs branch November 30, 2021 15:17
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants