Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #14224 +/- ##
============================================
- Coverage 19.91% 19.91% -0.01%
+ Complexity 20200 20196 -4
============================================
Files 6373 6373
Lines 577230 577220 -10
Branches 70696 70687 -9
============================================
- Hits 114974 114945 -29
- Misses 449690 449716 +26
+ Partials 12566 12559 -7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 7
Open (10)
maskSensitiveInfoInXML(xmlDesc)is evaluated eagerly even when DEBUG is disabled, which can be… · NewmaskSensitiveInfoInXML(xmlDesc)is evaluated eagerly even when DEBUG is disabled, which can be… · NewmaskSensitiveInfoInXML(xmlDesc)is evaluated eagerly even when DEBUG is disabled, which can be… · NewmaskSensitiveInfoInXML(xmlDesc)is evaluated eagerly even when DEBUG is disabled, which can be… · Newe.getMessage()and drop the stack trace, which makes… · Newe.getMessage()and drop the stack trace, which makes… · Newe.getMessage()and drop the stack trace, which makes… · NewString.valueOf(migrateDowntime)is unnecessary for parameterized logging (it will be converted… · New
What changed in this PR
Refactors KVM VM migration logging to be more consistent and contextual, primarily by switching to parameterized logging and standardizing messages for troubleshooting.
Changes:
- Replaced
String.format/string concatenation with parameterized logging across KVM migration flow. - Expanded log context (destination host, XML retrieval flag, job stats) for better traceability.
- Tweaked log levels/messages around migration timeouts and exception handling.
| File | Description |
|---|---|
| plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtMigrateCommandWrapper.java | Standardizes and enriches migration logs; adjusts log levels and message structure. |
| engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java | Fixes/standardizes config-drive detach logging and improves message quality. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| if (logger.isDebugEnabled()) { | ||
| logger.debug("VM {} with XML configuration {} will be migrated to host {}.", vmName, maskSensitiveInfoInXML(xmlDesc), target); | ||
| } | ||
| logger.debug("VM {} will be migrated to host {} with the following XML configuration retrieved with flag [{}]: {} .", vmName, target, xmlFlag, maskSensitiveInfoInXML(xmlDesc)); |
| if (logger.isDebugEnabled()) { | ||
| logger.debug("Replaced disk mount point {} with {} in Instance {} XML configuration. New XML configuration is {}.", oldIsoVolumePath, newIsoVolumePath, vmName, maskSensitiveInfoInXML(xmlDesc)); | ||
| } | ||
| logger.debug("Replaced disk mount point {} with {} in Instance {} XML configuration. New XML configuration is {}.", oldIsoVolumePath, newIsoVolumePath, vmName, maskSensitiveInfoInXML(xmlDesc)); |
| if (logger.isDebugEnabled()) { | ||
| logger.debug("Changed VM {} XML configuration of used storage. New XML configuration is {}.", vmName, maskSensitiveInfoInXML(xmlDesc)); | ||
| } | ||
| logger.debug("Changed VM {} XML configuration of used storage. New XML configuration is {}.", vmName, maskSensitiveInfoInXML(xmlDesc)); |
| if (logger.isDebugEnabled()) { | ||
| logger.debug("Changed VM {} XML configuration of DPDK interfaces. New XML configuration is {}.", vmName, maskSensitiveInfoInXML(xmlDesc)); | ||
| } | ||
| logger.debug("Changed VM {} XML configuration of DPDK interfaces. New XML configuration is {}.", vmName, maskSensitiveInfoInXML(xmlDesc)); |
| } | ||
| } catch (final LibvirtException e) { | ||
| logger.debug("Failed to set max downtime for migration, perhaps migration completed? Error: " + e.getMessage()); | ||
| logger.warn("Failed to set max downtime for migration. It might happen if the migration has already completed. Error: {}", e.getMessage()); |
| logger.info("VM domain state when trying to abort migration : {}", state); | ||
| } catch (final LibvirtException e) { | ||
| logger.info("Couldn't get VM domain state after " + sleeptime + "ms: " + e.getMessage()); | ||
| logger.warn("Could not get VM domain state after {}ms: {}", sleeptime, e.getMessage()); |
| } catch (final LibvirtException e) { | ||
| // pause could be racy if it attempts to pause right when vm is finished, simply warn | ||
| logger.info("Failed to pause vm " + vmName + " : " + e.getMessage()); | ||
| logger.warn("Failed to pause vm {} : {}", vmName, e.getMessage()); |
| if (logger.isDebugEnabled()) { | ||
| logger.debug("VM {} with XML configuration {} will be migrated to host {}.", vmName, maskSensitiveInfoInXML(xmlDesc), target); | ||
| } | ||
| logger.debug("VM {} will be migrated to host {} with the following XML configuration retrieved with flag [{}]: {} .", vmName, target, xmlFlag, maskSensitiveInfoInXML(xmlDesc)); |
| if (setDowntime == 0 ) { | ||
| isMigrateDowntimeSet = true; | ||
| logger.debug("Set max downtime for migration of " + vmName + " to " + String.valueOf(migrateDowntime) + "ms"); | ||
| logger.debug("Set max downtime for migration of {} to {}ms", vmName, String.valueOf(migrateDowntime)); |
| logger.info("VM domain state when trying to pause VM for migration: {}", state); | ||
| } catch (final LibvirtException e) { | ||
| logger.info("Couldn't get VM domain state after " + sleeptime + "ms: " + e.getMessage()); | ||
| logger.info("Could not get VM domain state after {}ms: {}",sleeptime, e.getMessage()); |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR focuses on improving the consistency and clarity of logging of the KVM VM migration process. The changes aim to improve the traceability of the process, by adding more context for the logs, helping future troubleshooting processes. It also standardizes log messages to use parametrized logging, instead of string concatenation.
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Screenshots (if appropriate):
How Has This Been Tested?
The code was compiled with Maven and installed to my local environment. Then, I migrated a VM from one of my hosts to another and verified that the new logs were displayed correctly.