Address review: enhance logs

Author: GabrielBrascher

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

@@ -4480,7 +4480,7 @@ private void orchestrateMigrateForScale(final String vmUuid, final long srcHostI
                     try {
                         _agentMgr.send(srcHostId, new Commands(cleanup(vm.getInstanceName())), null);
                     } catch (final AgentUnavailableException e) {
-                        s_logger.error(String.format("AgentUnavailableException while cleanup on source %s: ", srcHost), e);
+                        s_logger.error(String.format("Unable to cleanup source %s. ", srcHost), e);
                     }
                     cleanup(vmGuru, new VirtualMachineProfileImpl(vm), work, Event.AgentReportStopped, true);
                     throw new CloudRuntimeException("Unable to complete migration for " + vm);
@@ -4494,9 +4494,10 @@ private void orchestrateMigrateForScale(final String vmUuid, final long srcHostI
             if (!migrated) {
                 s_logger.info("Migration was unsuccessful.  Cleaning up: " + vm);
 
-                _alertMgr.sendAlert(alertType, fromHost.getDataCenterId(), fromHost.getPodId(),
-                        "Unable to migrate vm " + vm.getInstanceName() + " from " + fromHost + " in zone " + dest.getDataCenter().getName() + " and pod " +
-                                dest.getPod().getName(), "Migrate Command failed. Please check logs.");
+                String alertSubject = String.format("Unable to migrate VM [%s] from %s in Zone [%s] and Pod [%s].",
+                        vm.getInstanceName(), fromHost, dest.getDataCenter().getName(), dest.getPod().getName());
+                String alertBody = "Migrate Command failed. Please check logs.";
+                _alertMgr.sendAlert(alertType, fromHost.getDataCenterId(), fromHost.getPodId(), alertSubject, alertBody);
                 try {
                     _agentMgr.send(dstHostId, new Commands(cleanup(vm.getInstanceName())), null);
                 } catch (final AgentUnavailableException ae) {

server/src/main/java/com/cloud/network/element/VirtualRouterElement.java

@@ -411,7 +411,8 @@ public boolean stopVpn(final RemoteAccessVpn vpn) throws ResourceUnavailableExce
         if (canHandle(network, Service.Vpn)) {
             final List<DomainRouterVO> routers = _routerDao.listByNetworkAndRole(network.getId(), Role.VIRTUAL_ROUTER);
             if (routers == null || routers.isEmpty()) {
-                s_logger.debug(String.format("Virtual router element doesn't need stop VPN on the backend; virtual router doesn't exist in the network %s", network.getId()));
+                s_logger.debug(String.format("There is no virtual router in network [uuid: %s, name: %s], it is not necessary to stop the VPN on backend.",
+                        network.getUuid(), network.getName()));
                 return true;
             }
             return _routerMgr.deleteRemoteAccessVpn(network, vpn, routers);

server/src/main/java/com/cloud/resource/ResourceManagerImpl.java

@@ -2482,7 +2482,7 @@ public void deleteRoutingHost(final HostVO host, final boolean isForced, final b
                 try {
                     _vmMgr.destroy(vm.getUuid(), false);
                 } catch (final Exception e) {
-                    String errorMsg = String.format("There was an error when destroying the VM: %s as a part of hostDelete: %s", vm, host);
+                    String errorMsg = String.format("There was an error when destroying %s as a part of hostDelete for %s", vm, host);
                     s_logger.debug(errorMsg, e);
                     throw new UnableDeleteHostException(errorMsg + "," + e.getMessage());
                 }
@@ -2608,7 +2608,7 @@ protected void connectAndRestartAgentOnHost(HostVO host, String username, String
         final com.trilead.ssh2.Connection connection = SSHCmdHelper.acquireAuthorizedConnection(
                 host.getPrivateIpAddress(), 22, username, password);
         if (connection == null) {
-            throw new CloudRuntimeException(String.format("SSH to agent is enabled, but failed to connect to %s via IP address %s.", host, host.getPrivateIpAddress()));
+            throw new CloudRuntimeException(String.format("SSH to agent is enabled, but failed to connect to %s via IP address [%s].", host, host.getPrivateIpAddress()));
         }
         try {
             SSHCmdHelper.SSHCmdResult result = SSHCmdHelper.sshExecuteCmdOneShot(

server/src/main/java/com/cloud/resource/RollingMaintenanceManagerImpl.java

@@ -468,7 +468,7 @@ private Ternary<Boolean, Boolean, String> performPreMaintenanceStageOnHost(Host
             return new Ternary<>(true, false, result.second());
         }
         if (result.third() && !hostsToAvoidMaintenance.containsKey(host.getId())) {
-            s_logger.debug(String.format("%s added to the avoid maintenance set", host));
+            logHostAddedToAvoidMaintenanceSet(host);
             hostsToAvoidMaintenance.put(host.getId(), "Pre-maintenance stage set to avoid maintenance");
         }
         return new Ternary<>(false, false, result.second());
@@ -571,12 +571,16 @@ private void performPreFlightChecks(List<Host> hosts, int timeout, String payloa
         for (Host host : hosts) {
             Ternary<Boolean, String, Boolean> result = performStageOnHost(host, Stage.PreFlight, timeout, payload, forced);
             if (result.third() && !hostsToAvoidMaintenance.containsKey(host.getId())) {
-                s_logger.debug(String.format("%s added to the avoid maintenance set", host));
+                logHostAddedToAvoidMaintenanceSet(host);
                 hostsToAvoidMaintenance.put(host.getId(), "Pre-flight stage set to avoid maintenance");
             }
         }
     }
 
+    private void logHostAddedToAvoidMaintenanceSet(Host host) {
+        s_logger.debug(String.format("%s added to the avoid maintenance set.", host));
+    }
+
     /**
      * Capacity checks on hosts
      */