✨ Improve logging & error handling #2527

sbueringer · 2023-12-05T13:23:17Z

What this PR does / why we need it:
Final PR to close out #2076. I reviewed the entire code in the controller package and all log statements. I also made some improvements to error handling and some smaller bug fixes by opportunity.

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 #2076

codecov · 2023-12-05T15:04:22Z

Codecov Report

Attention: 400 lines in your changes are missing coverage. Please review.

Comparison is base (89f4029) 63.73% compared to head (3f27366) 63.45%.
Report is 10 commits behind head on main.

Files	Patch %	Lines
pkg/services/govmomi/util.go	16.94%	49 Missing ⚠️
pkg/services/govmomi/service.go	11.32%	47 Missing ⚠️
controllers/vspherecluster_reconciler.go	27.08%	33 Missing and 2 partials ⚠️
controllers/serviceaccount_controller.go	58.97%	27 Missing and 5 partials ⚠️
controllers/vspheremachine_controller.go	69.79%	26 Missing and 3 partials ⚠️
controllers/vspherevm_controller.go	52.08%	20 Missing and 3 partials ⚠️
controllers/servicediscovery_controller.go	75.64%	19 Missing ⚠️
pkg/session/session.go	56.41%	17 Missing ⚠️
pkg/util/machines.go	0.00%	15 Missing ⚠️
controllers/vspheredeploymentzone_controller.go	65.85%	14 Missing ⚠️
... and 21 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2527      +/-   ##
==========================================
- Coverage   63.73%   63.45%   -0.28%     
==========================================
  Files         123      120       -3     
  Lines        8812     8685     -127     
==========================================
- Hits         5616     5511     -105     
+ Misses       2773     2747      -26     
- Partials      423      427       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pkg/record/recorder.go

controllers/servicediscovery_controller.go

controllers/vspherecluster_reconciler.go

controllers/serviceaccount_controller.go

controllers/vspheredeploymentzone_controller_test.go

pkg/context/fake/fake_controller_context.go

pkg/services/vmoperator/vmopmachine.go

controllers/vspheremachine_controller.go

sbueringer · 2023-12-07T17:33:13Z

/test pull-cluster-api-provider-vsphere-e2e-full-main

sbueringer · 2023-12-07T17:33:37Z

/assign @fabriziopandini @chrischdi @adityabhatia Should be ready for review
(let's do a log walkthrough early next week though)

Would be good if we can hold other bigger changes to avoid rebasing this PR. I also spent a few hours reviewing this PR myself so it should be in pretty good shape at the moment.

fabriziopandini

just a couple of nits from my side

controllers/clustermodule_reconciler.go

controllers/serviceaccount_controller.go

controllers/vspherecluster_reconciler.go

controllers/vspheremachine_controller.go

chrischdi

A great PR which is a huge improvement to logging and helps in future to debug things!

pkg/services/govmomi/metadata/metadata.go

pkg/services/vmoperator/vmopmachine.go

pkg/services/govmomi/metadata/metadata.go

controllers/vmware/vspherecluster_reconciler.go

controllers/serviceaccount_controller.go

controllers/vsphereclusteridentity_controller.go

controllers/vmware/vspherecluster_reconciler.go

sbueringer · 2023-12-11T17:50:27Z

@adityabhatia @fabriziopandini @chrischdi Really appreciate the quick reviews. I know it's a huge PR.

fixed/answered PTAL :)

sbueringer · 2023-12-11T17:50:50Z

/test pull-cluster-api-provider-vsphere-e2e-full-main

chrischdi · 2023-12-12T07:38:45Z

/lgtm

k8s-ci-robot · 2023-12-12T07:38:51Z

LGTM label has been added.

Git tree hash: 30bef98f0738cd88409a519aef75f7e400413127

sbueringer · 2023-12-12T10:10:32Z

Squashed to make the PR mergable. Review fix commit can be seen here: b5286e5

sbueringer · 2023-12-12T10:10:42Z

/test pull-cluster-api-provider-vsphere-e2e-full-main

k8s-ci-robot · 2023-12-12T10:15:34Z

@sbueringer: 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-cluster-api-provider-vsphere-apidiff-main	`3f27366`	link	false	`/test pull-cluster-api-provider-vsphere-apidiff-main`

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.

fabriziopandini · 2023-12-12T10:34:06Z

Great work!
/lgtm

sbueringer · 2023-12-12T10:42:58Z

Going to merge to unblock other PRs given lgtm's above and Tide will wait for e2e-full to finish successfully

/approve

k8s-ci-robot · 2023-12-12T10:43:21Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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~~ [sbueringer]

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

sbueringer · 2023-12-12T13:29:38Z

/override codecov/patch

(running since 1h10m)

k8s-ci-robot · 2023-12-12T13:29:40Z

@sbueringer: /override requires failed status contexts, check run or a prowjob name to operate on.
The following unknown contexts/checkruns were given:

codecov/patch

Only the following failed contexts/checkruns were expected:

EasyCLA
lint
pull-cluster-api-provider-vsphere-apidiff-main
pull-cluster-api-provider-vsphere-e2e-full-main
pull-cluster-api-provider-vsphere-e2e-main
pull-cluster-api-provider-vsphere-test-integration-main
pull-cluster-api-provider-vsphere-test-main
pull-cluster-api-provider-vsphere-verify-main
tide

If you are trying to override a checkrun that has a space in it, you must put a double quote on the context.

In response to this:

/override codecov/patch

(running since 1h10m)

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 Dec 5, 2023

k8s-ci-robot requested review from MaxRink and gab-satchi December 5, 2023 13:23

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 5, 2023

sbueringer force-pushed the pr-finalize-logging branch 4 times, most recently from b672c06 to 022a509 Compare December 5, 2023 14:59

sbueringer force-pushed the pr-finalize-logging branch from 022a509 to 0c6edda Compare December 5, 2023 15:29

sbueringer mentioned this pull request Dec 6, 2023

🌱 Add test coverage for VimMachineService #2444

Merged

sbueringer force-pushed the pr-finalize-logging branch 6 times, most recently from 1a13b51 to b0c5116 Compare December 7, 2023 17:29

sbueringer commented Dec 7, 2023

View reviewed changes

sbueringer changed the title ~~[WIP] ✨ Improve logging & error handling~~ ✨ Improve logging & error handling Dec 7, 2023

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 Dec 7, 2023

sbueringer mentioned this pull request Dec 8, 2023

🌱 Introduce a new go.mod for test/ #2532

Merged

fabriziopandini reviewed Dec 11, 2023

View reviewed changes

controllers/clustermodule_reconciler.go Outdated Show resolved Hide resolved

controllers/serviceaccount_controller.go Outdated Show resolved Hide resolved

controllers/vspherecluster_reconciler.go Show resolved Hide resolved

controllers/vspheremachine_controller.go Show resolved Hide resolved

chrischdi reviewed Dec 11, 2023

View reviewed changes

adityabhatia reviewed Dec 11, 2023

View reviewed changes

controllers/vmware/vspherecluster_reconciler.go Outdated Show resolved Hide resolved

k8s-ci-robot assigned chrischdi Dec 12, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 12, 2023

Improve logging and error handling

3f27366

sbueringer force-pushed the pr-finalize-logging branch from b5286e5 to 3f27366 Compare December 12, 2023 10:08

k8s-ci-robot assigned fabriziopandini Dec 12, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 12, 2023

k8s-ci-robot merged commit d9910c6 into kubernetes-sigs:main Dec 12, 2023

k8s-ci-robot added this to the v1.9 milestone Dec 12, 2023

sbueringer deleted the pr-finalize-logging branch December 12, 2023 13:48

sbueringer mentioned this pull request Dec 12, 2023

🌱 Set log level 5 for vm operator tests #2547

Merged

✨ Improve logging & error handling #2527

✨ Improve logging & error handling #2527

Uh oh!

Conversation

sbueringer commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sbueringer commented Dec 7, 2023

Uh oh!

sbueringer commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabriziopandini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrischdi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sbueringer commented Dec 11, 2023

Uh oh!

sbueringer commented Dec 11, 2023

Uh oh!

chrischdi commented Dec 12, 2023

Uh oh!

k8s-ci-robot commented Dec 12, 2023

Uh oh!

sbueringer commented Dec 12, 2023

Uh oh!

sbueringer commented Dec 12, 2023

Uh oh!

k8s-ci-robot commented Dec 12, 2023

Uh oh!

fabriziopandini commented Dec 12, 2023

Uh oh!

sbueringer commented Dec 12, 2023

Uh oh!

k8s-ci-robot commented Dec 12, 2023

Uh oh!

sbueringer commented Dec 12, 2023

Uh oh!

k8s-ci-robot commented Dec 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sbueringer commented Dec 5, 2023 •

edited

Loading

codecov bot commented Dec 5, 2023 •

edited

Loading

sbueringer commented Dec 7, 2023 •

edited

Loading