Skip to content

MGMT-18930: Consolidate static network configuration log messages #7592

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

Merged

Conversation

yoavsc0302
Copy link
Contributor

This commit changes the logging behavior in the StaticNetworkConfigGenerator to reduce log verbosity by consolidating multiple individual "Adding NMConnection file" log messages into a single message. Instead of logging each NM connection file separately, the code now collects all file names and outputs them in a single log entry.

List all the issues related to this PR

  • New Feature
  • Enhancement
  • Bug fix
  • Tests
  • Documentation
  • CI/CD

What environments does this code impact?

  • Automation (CI, tools, etc)
  • Cloud
  • Operator Managed Deployments
  • None

How was this code tested?

  • assisted-test-infra environment
  • dev-scripts environment
  • Reviewer's test appreciated
  • Waiting for CI to do a full test run
  • Manual (Elaborate on how it was tested)
  • No tests needed

Checklist

  • Title and description added to both, commit and PR.
  • Relevant issues have been associated (see CONTRIBUTING guide)
  • This change does not require a documentation update (docstring, docs, README, etc)
  • Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Apr 20, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 20, 2025

@yoavsc0302: This pull request references MGMT-18930 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 task to target the "4.19.0" version, but no target version was set.

In response to this:

This commit changes the logging behavior in the StaticNetworkConfigGenerator to reduce log verbosity by consolidating multiple individual "Adding NMConnection file" log messages into a single message. Instead of logging each NM connection file separately, the code now collects all file names and outputs them in a single log entry.

List all the issues related to this PR

  • New Feature
  • Enhancement
  • Bug fix
  • Tests
  • Documentation
  • CI/CD

What environments does this code impact?

  • Automation (CI, tools, etc)
  • Cloud
  • Operator Managed Deployments
  • None

How was this code tested?

  • assisted-test-infra environment
  • dev-scripts environment
  • Reviewer's test appreciated
  • Waiting for CI to do a full test run
  • Manual (Elaborate on how it was tested)
  • No tests needed

Checklist

  • Title and description added to both, commit and PR.
  • Relevant issues have been associated (see CONTRIBUTING guide)
  • This change does not require a documentation update (docstring, docs, README, etc)
  • Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

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.

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 20, 2025
@openshift-ci openshift-ci bot requested review from danmanor and javipolo April 20, 2025 12:03
Copy link

codecov bot commented Apr 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.56%. Comparing base (b6266c1) to head (ab72088).
Report is 10 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #7592      +/-   ##
==========================================
+ Coverage   67.32%   67.56%   +0.24%     
==========================================
  Files         335      335              
  Lines       42344    42658     +314     
==========================================
+ Hits        28509    28824     +315     
- Misses      11263    11266       +3     
+ Partials     2572     2568       -4     
Files with missing lines Coverage Δ
pkg/staticnetworkconfig/generator.go 67.73% <100.00%> (+0.41%) ⬆️

... and 4 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines 271 to 274
if len(connectionFileNames) > 0 {
s.log.Infof("Adding NMConnection files: <%s>", strings.Join(connectionFileNames, ">, <"))
}
Copy link
Contributor

@linoyaslan linoyaslan Apr 20, 2025

Choose a reason for hiding this comment

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

Suggested change
if len(connectionFileNames) > 0 {
s.log.Infof("Adding NMConnection files: <%s>", strings.Join(connectionFileNames, ">, <"))
}
if len(filesList) > 0 {
s.log.Infof("Adding NMConnection files: <%s>",
strings.Join(lo.Map(filesList, func(f StaticNetworkConfigData, _ int) string {
return filepath.Base(f.FilePath)
}), ">, <"),
)
}

What do you think?
I'm not sure which approach is better, but AFAIK, using append can be less efficient in terms of performance. I'm also not sure if it's worth creating a new list and using append just for an info log...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with you. I've changed that accordingly in the commit to improve performance after testing it passes the tests and works correctly in test-infra.

This commit changes the logging behavior in the StaticNetworkConfigGenerator to reduce log verbosity by consolidating multiple individual "Adding NMConnection file" log messages into a single message. Instead of logging each NM connection file separately, the code now collects all file names and outputs them in a single log entry.
@yoavsc0302 yoavsc0302 force-pushed the MGMT-18930/cleanup-logs branch from 98732ed to ab72088 Compare April 21, 2025 15:20
@linoyaslan
Copy link
Contributor

/test ?

Copy link

openshift-ci bot commented Apr 22, 2025

@linoyaslan: The following commands are available to trigger required jobs:

/test e2e-agent-compact-ipv4
/test edge-assisted-operator-catalog-publish-verify
/test edge-ci-index
/test edge-e2e-ai-operator-disconnected-capi
/test edge-e2e-ai-operator-ztp
/test edge-e2e-ai-operator-ztp-3masters
/test edge-e2e-ai-operator-ztp-capi
/test edge-e2e-ai-operator-ztp-disconnected
/test edge-e2e-metal-assisted-4-14
/test edge-e2e-metal-assisted-4-15
/test edge-e2e-metal-assisted-4-16
/test edge-e2e-metal-assisted-4-17
/test edge-e2e-metal-assisted-4-19
/test edge-e2e-metal-assisted-5-control-planes-4-19
/test edge-e2e-metal-assisted-cnv-4-18
/test edge-e2e-metal-assisted-external-4-19
/test edge-e2e-metal-assisted-kdo-4-19
/test edge-e2e-metal-assisted-lvm-4-19
/test edge-e2e-metal-assisted-mtv-4-18
/test edge-e2e-metal-assisted-nho-snr-far-4-19
/test edge-e2e-metal-assisted-nmo-4-19
/test edge-e2e-metal-assisted-none-4-19
/test edge-e2e-metal-assisted-odf-4-18
/test edge-e2e-metal-assisted-osc-4-19
/test edge-e2e-nutanix-assisted-2workers-4-19
/test edge-e2e-nutanix-assisted-4-19
/test edge-e2e-vsphere-assisted-4-19
/test edge-images
/test edge-lint
/test edge-operator-publish-verify
/test edge-subsystem-aws
/test edge-subsystem-kubeapi-aws
/test edge-unit-test
/test edge-verify-generated-code
/test images
/test mce-images

The following commands are available to trigger optional jobs:

/test e2e-agent-4control-ipv4
/test e2e-agent-5control-ipv4
/test e2e-agent-ha-dualstack
/test e2e-agent-sno-ipv6
/test edge-e2e-ai-operator-ztp-4masters
/test edge-e2e-ai-operator-ztp-5masters
/test edge-e2e-ai-operator-ztp-compact-day2-masters
/test edge-e2e-ai-operator-ztp-compact-day2-workers
/test edge-e2e-ai-operator-ztp-multiarch-3masters-ocp
/test edge-e2e-ai-operator-ztp-multiarch-sno-ocp
/test edge-e2e-ai-operator-ztp-node-labels
/test edge-e2e-ai-operator-ztp-remove-node
/test edge-e2e-ai-operator-ztp-sno-day2-masters
/test edge-e2e-ai-operator-ztp-sno-day2-workers
/test edge-e2e-ai-operator-ztp-sno-day2-workers-ignitionoverride
/test edge-e2e-ai-operator-ztp-sno-day2-workers-late-binding
/test edge-e2e-metal-assisted-4-control-planes-4-19
/test edge-e2e-metal-assisted-4-masters-none-4-19
/test edge-e2e-metal-assisted-bond-4-14
/test edge-e2e-metal-assisted-bond-4-19
/test edge-e2e-metal-assisted-day2-4-19
/test edge-e2e-metal-assisted-day2-arm-workers-4-19
/test edge-e2e-metal-assisted-day2-sno-4-19
/test edge-e2e-metal-assisted-ipv4v6-4-19
/test edge-e2e-metal-assisted-ipv6-4-19
/test edge-e2e-metal-assisted-k8s-nmstate-4-19
/test edge-e2e-metal-assisted-kube-api-late-binding-sno-4-19
/test edge-e2e-metal-assisted-kube-api-late-unbinding-sno-4-19
/test edge-e2e-metal-assisted-kube-api-net-suite-4-19
/test edge-e2e-metal-assisted-kube-api-umlb-4-19
/test edge-e2e-metal-assisted-onprem-4-19
/test edge-e2e-metal-assisted-osc-sno-4-19
/test edge-e2e-metal-assisted-sno-4-19
/test edge-e2e-metal-assisted-static-ip-suite-4-14
/test edge-e2e-metal-assisted-static-ip-suite-4-19
/test edge-e2e-metal-assisted-tang-4-19
/test edge-e2e-metal-assisted-tpmv2-4-19
/test edge-e2e-metal-assisted-umlb-4-19
/test edge-e2e-metal-assisted-upgrade-agent-4-19
/test edge-e2e-oci-assisted-4-19
/test edge-e2e-oci-assisted-bm-iscsi-4-19
/test edge-e2e-vsphere-assisted-umlb-4-19
/test edge-e2e-vsphere-assisted-umn-4-19
/test okd-scos-e2e-aws-ovn
/test okd-scos-images
/test push-pr-image

Use /test all to run the following jobs that were automatically triggered:

pull-ci-openshift-assisted-service-master-e2e-agent-compact-ipv4
pull-ci-openshift-assisted-service-master-edge-ci-index
pull-ci-openshift-assisted-service-master-edge-e2e-ai-operator-ztp
pull-ci-openshift-assisted-service-master-edge-e2e-metal-assisted-4-19
pull-ci-openshift-assisted-service-master-edge-images
pull-ci-openshift-assisted-service-master-edge-lint
pull-ci-openshift-assisted-service-master-edge-subsystem-aws
pull-ci-openshift-assisted-service-master-edge-subsystem-kubeapi-aws
pull-ci-openshift-assisted-service-master-edge-unit-test
pull-ci-openshift-assisted-service-master-edge-verify-generated-code
pull-ci-openshift-assisted-service-master-images
pull-ci-openshift-assisted-service-master-mce-images
pull-ci-openshift-assisted-service-master-okd-scos-e2e-aws-ovn

In response to this:

/test ?

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.

@linoyaslan
Copy link
Contributor

/test edge-e2e-metal-assisted-static-ip-suite-4-14

@linoyaslan
Copy link
Contributor

/retest

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 22, 2025
Copy link

openshift-ci bot commented Apr 22, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: linoyaslan, yoavsc0302

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 22, 2025
@yoavsc0302
Copy link
Contributor Author

/retest

@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD 3441575 and 2 for PR HEAD ab72088 in total

@yoavsc0302
Copy link
Contributor Author

/retest

@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD 3441575 and 2 for PR HEAD ab72088 in total

@yoavsc0302
Copy link
Contributor Author

/retest

Copy link

openshift-ci bot commented Apr 24, 2025

@yoavsc0302: 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
ci/prow/okd-scos-e2e-aws-ovn ab72088 link false /test okd-scos-e2e-aws-ovn

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@openshift-merge-bot openshift-merge-bot bot merged commit f16bd90 into openshift:master Apr 24, 2025
20 of 21 checks passed
@openshift-bot
Copy link
Contributor

[ART PR BUILD NOTIFIER]

Distgit: ose-agent-installer-api-server
This PR has been included in build ose-agent-installer-api-server-container-v4.20.0-202504241659.p0.gf16bd90.assembly.stream.el9.
All builds following this will include this PR.

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. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. 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.

4 participants