CNTRLPLANE-3384: Remove unconditional low-quality log messages from controllers#8428
CNTRLPLANE-3384: Remove unconditional low-quality log messages from controllers#8428csrwng wants to merge 1 commit intoopenshift:mainfrom
Conversation
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
|
Skipping CI for Draft Pull Request. |
|
@csrwng: This pull request references CNTRLPLANE-3384 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: csrwng The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
These log messages (e.g. log.Info("Reconciling"), log.Info("reconcile
complete")) provide no clear information and are emitted on every
reconcile invocation, leading to excessive log noise. controller-runtime
already provides reconcile lifecycle tracing at debug verbosity.
Remove entry/exit logs and sub-function announcement logs from 18
controllers across the CPO and HO. Clean up unused variables and
imports where applicable.
Signed-off-by: Cesar Wong <cewong@redhat.com>
Commit-Message-Assisted-by: Claude (via Claude Code)
1f358a6 to
fc7aa60
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (18)
💤 Files with no reviewable changes (18)
📝 WalkthroughWalkthroughThis pull request removes informational log statements from reconciliation methods across multiple Kubernetes controllers in the control-plane-operator and hypershift-operator projects. The changes eliminate startup logs (typically 🚥 Pre-merge checks | ✅ 12✅ Passed checks (12 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8428 +/- ##
==========================================
+ Coverage 37.39% 37.42% +0.02%
==========================================
Files 751 751
Lines 91806 91806
==========================================
+ Hits 34333 34356 +23
+ Misses 54838 54813 -25
- Partials 2635 2637 +2
... and 1 file with indirect coverage changes
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
@csrwng: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. I understand the commands that are listed here. |
Summary
log.Info("Reconciling"),log.Info("reconciliation complete"), and equivalent messages from 18 controllers across the CPO and HOContext
These log messages provide no actionable information and are emitted on every reconcile invocation, including frequent re-queues. controller-runtime already provides reconcile lifecycle tracing at debug verbosity. In management clusters running many HostedClusters (e.g., ARO HCP), this produces significant log noise that obscures meaningful events during incident investigation.
Identified during a debugging session investigating cluster deletion issues in the managed Azure service (ARO HCP).
Jira
https://issues.redhat.com/browse/CNTRLPLANE-3384
Test plan
make testpassesmake buildpassesSummary by CodeRabbit