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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌱 Add reconciler name to loggers for context #5151

Merged

Conversation

killianmuldoon
Copy link
Contributor

The reconciler name is added to the controller runtime logger for
each of the reconcilers in CAPI on start up. This lets the logs be
more easily parsed and distinguished from each other.

c/f #5134 which does the same thing for the new topology/cluster controller.

Signed-off-by: killianmuldoon [email protected]

Fixes #5147

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 25, 2021
@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot 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 Aug 25, 2021
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 25, 2021
@killianmuldoon
Copy link
Contributor Author

I skipped two reconcilers in this PR - the topology/cluster reconciler which is being taken care of in #5134 and the dockerCluster reconciler which currently doesn't take controller runtime options. I'll add the pattern there in a second commit which as it's a slightly different change.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 25, 2021
@killianmuldoon killianmuldoon force-pushed the add-reconciler-to-logs branch from c8e18ea to 034f259 Compare August 25, 2021 14:26
@fabriziopandini
Copy link
Member

/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 Aug 25, 2021
@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 25, 2021
@vincepri
Copy link
Member

Is a value preferred to use WithName?

@sbueringer
Copy link
Member

sbueringer commented Aug 25, 2021

Is a value preferred to use WithName?

Fabrizio tried it with WithName and imho it looks really awkward. Something like this

I0820 18:26:01.101336      35 reconcile_state.go:41] controller-runtime/manager/<NAME>/controller/cluster "msg"="Reconciling state for topology owned objects" ...

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 26, 2021
@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 26, 2021
@sbueringer
Copy link
Member

/lgtm + I think you can squash

The reconciler name is added to the controller runtime logger for
each of the reconcilers in CAPI on start up. This lets the logs be
more easily parsed and distinguished from each other.

Signed-off-by: killianmuldoon <[email protected]>
@killianmuldoon killianmuldoon force-pushed the add-reconciler-to-logs branch from e6308bd to fb4569a Compare August 26, 2021 11:52
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 26, 2021
@sbueringer
Copy link
Member

/lgtm

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

@vincepri vincepri 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
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 Aug 26, 2021
@k8s-ci-robot k8s-ci-robot merged commit b0e4c8b into kubernetes-sigs:master Aug 26, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Aug 26, 2021
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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add reconciler key to the loggers of all reconcilers
5 participants