Improve logging to include more identifiable information

agent/src/main/java/com/cloud/agent/Agent.java

@@ -132,6 +132,8 @@
     ServerResource _resource;
     Link _link;
     Long _id;
+    String _uuid;
+    String _name;
 
     Timer _timer = new Timer("Agent Timer");
     Timer certTimer;
@@ -182,8 +184,10 @@
         resource.setAgentControl(this);
 
         final String value = _shell.getPersistentProperty(getResourceName(), "id");
+        _uuid = _shell.getPersistentProperty(getResourceName(), "uuid");
+        _name = _shell.getPersistentProperty(getResourceName(), "name");
         _id = value != null ? Long.parseLong(value) : null;
-        logger.info("id is {}", ObjectUtils.defaultIfNull(_id, ""));
+        logger.info("Initialising agent [id: {}, uuid: {}, name: {}]", ObjectUtils.defaultIfNull(_id, ""), _uuid, _name);
 
         final Map<String, Object> params = new HashMap<>();
 
@@ -212,8 +216,9 @@
                 new ThreadPoolExecutor(_shell.getWorkers(), 5 * _shell.getWorkers(), 1, TimeUnit.DAYS, new LinkedBlockingQueue<Runnable>(), new NamedThreadFactory(
                         "agentRequest-Handler"));
 
-        logger.info("Agent [id = {} : type = {} : zone = {} : pod = {} : workers = {} : host = {} : port = {}", ObjectUtils.defaultIfNull(_id, "new"), getResourceName(),
-                 _shell.getZone(), _shell.getPod(), _shell.getWorkers(), host, _shell.getPort());
+        logger.info("Agent [id = {}, uuid: {}, name: {}] : type = {} : zone = {} : pod = {} : workers = {} : host = {} : port = {}",
+                ObjectUtils.defaultIfNull(_id, "new"), _uuid, _name, getResourceName(),
+                _shell.getZone(), _shell.getPod(), _shell.getWorkers(), host, _shell.getPort());
     }
 
     public String getVersion() {
@@ -377,11 +382,28 @@
     }
 
     public void setId(final Long id) {
-        logger.debug("Set agent id {}", id);
         _id = id;
         _shell.setPersistentProperty(getResourceName(), "id", Long.toString(id));
     }
 
+    public String getUuid() {
+        return _uuid;
+    }
+
+    public void setUuid(String uuid) {
+        this._uuid = uuid;
+        _shell.setPersistentProperty(getResourceName(), "uuid", uuid);
+    }
+
+    public String getName() {
+        return _name;
+    }
+
+    public void setName(String name) {
+        this._name = name;
+        _shell.setPersistentProperty(getResourceName(), "name", name);
+    }
+
     private synchronized void scheduleServicesRestartTask() {
         if (certTimer != null) {
             certTimer.cancel();
@@ -594,19 +616,21 @@
             return;
         }
 
-        logger.info("Process agent startup answer, agent [id: {}, name: {}] connected to the server",
-                startup.getHostId(), startup.getHostName());
+        logger.info("Process agent startup answer, agent [id: {}, uuid: {}, name: {}] connected to the server",
+                startup.getHostId(), startup.getHostUuid(), startup.getHostName());
 
         setId(startup.getHostId());
+        setUuid(startup.getHostUuid());
+        setName(startup.getHostName());
         _pingInterval = (long)startup.getPingInterval() * 1000; // change to ms.
 
         setLastPingResponseTime();
         scheduleWatch(link, response, _pingInterval, _pingInterval);
 
         _ugentTaskPool.setKeepAliveTime(2 * _pingInterval, TimeUnit.MILLISECONDS);
 
-        logger.info("Startup Response Received: agent [id: {}, name: {}]",
-                getId(), startup.getHostName());
+        logger.info("Startup Response Received: agent [id: {}, uuid: {}, name: {}]",
+                startup.getHostId(), startup.getHostUuid(), startup.getHostName());
     }
 
     protected void processRequest(final Request request, final Link link) {
@@ -862,15 +886,17 @@
             NumbersUtil.enableHumanReadableSizes = humanReadable;
         }
 
-        logger.info("Processing agent ready command, agent id = {}", ready.getHostId());
+        logger.info("Processing agent ready command, agent id = {}, uuid = {}, name = {}", ready.getHostId(), ready.getHostUuid(), ready.getHostName());
         if (ready.getHostId() != null) {
             setId(ready.getHostId());
+            setUuid(ready.getHostUuid());
+            setName(ready.getHostName());
         }
 
         verifyAgentArch(ready.getArch());
         processManagementServerList(ready.getMsHostList(), ready.getLbAlgorithm(), ready.getLbCheckInterval());
 
-        logger.info("Ready command is processed for agent id = {}", getId());
+        logger.info("Ready command is processed for agent [id: {}, uuid: {}, name: {}]", getId(), getUuid(), getName());
     }
 
     private void verifyAgentArch(String arch) {

api/src/main/java/com/cloud/agent/api/to/LoadBalancerTO.java

@@ -374,13 +374,15 @@
     public static class CounterTO implements Serializable {
         private static final long serialVersionUID = 2L;
         private final Long id;
+        private final String uuid;
         private final String name;
         private final Counter.Source source;
         private final String value;
         private final String provider;
 
-        public CounterTO(Long id, String name, Counter.Source source, String value, String provider) {
+        public CounterTO(Long id, String uuid, String name, Counter.Source source, String value, String provider) {
             this.id = id;
+            this.uuid = uuid;
             this.name = name;
             this.source = source;
             this.value = value;
@@ -391,6 +393,10 @@
             return id;
         }
 
+        public String getUuid() {
+            return uuid;
+        }
+
         public String getName() {
             return name;
         }
@@ -411,12 +417,14 @@
     public static class ConditionTO implements Serializable {
         private static final long serialVersionUID = 2L;
         private final Long id;
+        private final String uuid;
         private final long threshold;
         private final Condition.Operator relationalOperator;
         private final CounterTO counter;
 
-        public ConditionTO(Long id, long threshold, Condition.Operator relationalOperator, CounterTO counter) {
+        public ConditionTO(Long id, String uuid, long threshold, Condition.Operator relationalOperator, CounterTO counter) {
             this.id = id;
+            this.uuid = uuid;
             this.threshold = threshold;
             this.relationalOperator = relationalOperator;
             this.counter = counter;
@@ -426,6 +434,10 @@
             return id;
         }
 
+        public String getUuid() {
+            return uuid;
+        }
+
         public long getThreshold() {
             return threshold;
         }
@@ -442,15 +454,17 @@
     public static class AutoScalePolicyTO implements Serializable {
         private static final long serialVersionUID = 2L;
         private final long id;
+        private final String uuid;
         private final int duration;
         private final int quietTime;
         private final Date lastQuietTime;
         private AutoScalePolicy.Action action;
         boolean revoked;
         private final List<ConditionTO> conditions;
 
-        public AutoScalePolicyTO(long id, int duration, int quietTime, Date lastQuietTime, AutoScalePolicy.Action action, List<ConditionTO> conditions, boolean revoked) {
+        public AutoScalePolicyTO(long id, String uuid, int duration, int quietTime, Date lastQuietTime, AutoScalePolicy.Action action, List<ConditionTO> conditions, boolean revoked) {
             this.id = id;
+            this.uuid = uuid;
             this.duration = duration;
             this.quietTime = quietTime;
             this.lastQuietTime = lastQuietTime;
@@ -463,6 +477,10 @@
             return id;
         }
 
+        public String getUuid() {
+            return uuid;
+        }
+
         public int getDuration() {
             return duration;
         }

api/src/main/java/com/cloud/agent/api/to/NfsTO.java

@@ -17,6 +17,7 @@
 package com.cloud.agent.api.to;
 
 import com.cloud.storage.DataStoreRole;
+import org.apache.cloudstack.utils.reflectiontostringbuilderutils.ReflectionToStringBuilderUtils;
 
 public class NfsTO implements DataStoreTO {
 
@@ -41,6 +42,13 @@
 
     }
 
+    @Override
+    public String toString() {
+        return String.format("NfsTO %s",
+                ReflectionToStringBuilderUtils.reflectOnlySelectedFields(
+                        this, "uuid", "_url", "_role", "nfsVersion"));
+    }
+
     @Override
     public String getUrl() {
         return _url;

api/src/main/java/com/cloud/agent/api/to/S3TO.java

@@ -22,6 +22,7 @@
 import com.cloud.agent.api.LogLevel.Log4jLevel;
 import com.cloud.storage.DataStoreRole;
 import com.cloud.utils.storage.S3.ClientOptions;
+import org.apache.cloudstack.utils.reflectiontostringbuilderutils.ReflectionToStringBuilderUtils;
 
 public final class S3TO implements ClientOptions, DataStoreTO {
 
@@ -68,6 +69,13 @@
 
     }
 
+    @Override
+    public String toString() {
+        return String.format("S3TO %s",
+                ReflectionToStringBuilderUtils.reflectOnlySelectedFields(
+                        this, "id", "uuid", "bucketName"));
+    }
+
     public Long getId() {
         return this.id;
     }

api/src/main/java/com/cloud/agent/api/to/SwiftTO.java

@@ -18,6 +18,7 @@
 
 import com.cloud.storage.DataStoreRole;
 import com.cloud.utils.SwiftUtil;
+import org.apache.cloudstack.utils.reflectiontostringbuilderutils.ReflectionToStringBuilderUtils;
 
 public class SwiftTO implements DataStoreTO, SwiftUtil.SwiftClientCfg {
     Long id;
@@ -41,6 +42,13 @@
         this.storagePolicy = storagePolicy;
     }
 
+    @Override
+    public String toString() {
+        return String.format("SwiftTO %s",
+                ReflectionToStringBuilderUtils.reflectOnlySelectedFields(
+                        this, "id", "account", "userName"));
+    }
+
     public Long getId() {
         return id;
     }

api/src/main/java/com/cloud/network/Ipv6Service.java

@@ -58,7 +58,7 @@ public interface Ipv6Service extends PluggableService, Configurable {
 
     Pair<Integer, Integer> getUsedTotalIpv6SubnetForZone(long zoneId);
 
-    Pair<String, String> preAllocateIpv6SubnetForNetwork(long zoneId) throws ResourceAllocationException;
+    Pair<String, String> preAllocateIpv6SubnetForNetwork(DataCenter zone) throws ResourceAllocationException;
 
     void assignIpv6SubnetToNetwork(String subnet, long networkId);
 

api/src/main/java/com/cloud/network/NetworkProfile.java

@@ -22,6 +22,7 @@
 import com.cloud.network.Networks.BroadcastDomainType;
 import com.cloud.network.Networks.Mode;
 import com.cloud.network.Networks.TrafficType;
+import org.apache.cloudstack.utils.reflectiontostringbuilderutils.ReflectionToStringBuilderUtils;
 
 public class NetworkProfile implements Network {
     private final long id;
@@ -384,4 +385,11 @@
         return networkCidrSize;
     }
 
+    @Override
+    public String toString() {
+        return String.format("NetworkProfile %s",
+                ReflectionToStringBuilderUtils.reflectOnlySelectedFields(
+                        this, "id", "uuid", "name", "networkOfferingId"));
+    }
+
 }

api/src/main/java/com/cloud/network/lb/LoadBalancingRule.java

@@ -63,6 +63,10 @@
         return lb.getId();
     }
 
+    public LoadBalancer getLb() {
+        return lb;
+    }
+
     public String getName() {
         return lb.getName();
     }

api/src/main/java/com/cloud/network/vpn/RemoteAccessVpnService.java

@@ -39,7 +39,7 @@ public interface RemoteAccessVpnService {
 
     VpnUser addVpnUser(long vpnOwnerId, String userName, String password);
 
-    boolean removeVpnUser(long vpnOwnerId, String userName, Account caller);
+    boolean removeVpnUser(Account vpnOwner, String userName, Account caller);
 
     List<? extends VpnUser> listVpnUsers(long vpnOwnerId, String userName);
 

api/src/main/java/com/cloud/region/ha/GlobalLoadBalancingRulesService.java

@@ -19,6 +19,7 @@
 
 import java.util.List;
 
+import com.cloud.user.Account;
 import org.apache.cloudstack.api.command.user.region.ha.gslb.AssignToGlobalLoadBalancerRuleCmd;
 import org.apache.cloudstack.api.command.user.region.ha.gslb.CreateGlobalLoadBalancerRuleCmd;
 import org.apache.cloudstack.api.command.user.region.ha.gslb.DeleteGlobalLoadBalancerRuleCmd;
@@ -39,7 +40,7 @@ public interface GlobalLoadBalancingRulesService {
 
     GlobalLoadBalancerRule updateGlobalLoadBalancerRule(UpdateGlobalLoadBalancerRuleCmd updateGslbCmd);
 
-    boolean revokeAllGslbRulesForAccount(com.cloud.user.Account caller, long accountId) throws com.cloud.exception.ResourceUnavailableException;
+    boolean revokeAllGslbRulesForAccount(com.cloud.user.Account caller, Account account) throws com.cloud.exception.ResourceUnavailableException;
 
     /*
      * methods for managing sites participating in global load balancing

api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java

@@ -125,8 +125,9 @@
             hostResponse.setResponseName(getCommandName());
             this.setResponseObject(hostResponse);
         } catch (Exception e) {
-            logger.debug("Failed to update host:" + getId(), e);
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update host:" + getId() + "," + e.getMessage());
+            Host host = _entityMgr.findById(Host.class, getId());
+            logger.debug("Failed to update host: {} with id {}", host, getId(), e);
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to update host: %s with id %d, %s", host, getId(), e.getMessage()));
         }
     }
 }

api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotFromVMSnapshotCmd.java

@@ -124,10 +124,10 @@
         if (account.getType() == Account.Type.PROJECT) {
             Project project = _projectService.findByProjectAccountId(vmsnapshot.getAccountId());
             if (project == null) {
-                throw new InvalidParameterValueException("Unable to find project by account id=" + account.getUuid());
+                throw new InvalidParameterValueException(String.format("Unable to find project by account %s", account));
             }
             if (project.getState() != Project.State.Active) {
-                throw new PermissionDeniedException("Can't add resources to the project id=" + project.getUuid() + " in state=" + project.getState() + " as it's no longer active");
+                throw new PermissionDeniedException(String.format("Can't add resources to the project %s in state=%s as it's no longer active", project, project.getState()));
             }
         } else if (account.getState() == Account.State.DISABLED) {
             throw new PermissionDeniedException("The owner of template is disabled: " + account);
@@ -164,8 +164,9 @@
 
     @Override
     public void execute() {
-        logger.info("CreateSnapshotFromVMSnapshotCmd with vm snapshot id:" + getVMSnapshotId() + " and snapshot id:" + getEntityId() + " starts:" + System.currentTimeMillis());
-        CallContext.current().setEventDetails("Vm Snapshot Id: "+ this._uuidMgr.getUuid(VMSnapshot.class, getVMSnapshotId()));
+        VMSnapshot vmSnapshot = _vmSnapshotService.getVMSnapshotById(getVMSnapshotId());
+        logger.info("CreateSnapshotFromVMSnapshotCmd with vm snapshot {} with id {} and snapshot [id: {}, uuid: {}]", vmSnapshot, getVMSnapshotId(), getEntityId(), getEntityUuid());
+        CallContext.current().setEventDetails("Vm Snapshot Id: " + vmSnapshot.getUuid());
         Snapshot snapshot = null;
         try {
             snapshot = _snapshotService.backupSnapshotFromVmSnapshot(getEntityId(), getVmId(), getVolumeId(), getVMSnapshotId());
@@ -174,19 +175,19 @@
                 response.setResponseName(getCommandName());
                 this.setResponseObject(response);
             } else {
-                throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create snapshot due to an internal error creating snapshot from vm snapshot " + getVMSnapshotId());
+                throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to create snapshot due to an internal error creating snapshot from vm snapshot %s", vmSnapshot));
             }
         } catch (InvalidParameterValueException ex) {
             throw ex;
         } catch (Exception e) {
             logger.debug("Failed to create snapshot", e);
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create snapshot due to an internal error creating snapshot from vm snapshot " + getVMSnapshotId());
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to create snapshot due to an internal error creating snapshot from vm snapshot %s", vmSnapshot));
         } finally {
             if (snapshot == null) {
                 try {
                     _snapshotService.deleteSnapshot(getEntityId(), null);
                 } catch (Exception e) {
-                    logger.debug("Failed to clean failed snapshot" + getEntityId());
+                    logger.debug("Failed to clean failed snapshot {} with id {}", () -> _entityMgr.findById(Snapshot.class, getEntityId()), this::getEntityId);
                 }
             }
         }

api/src/main/java/org/apache/cloudstack/api/command/user/vpn/RemoveVpnUserCmd.java

@@ -104,7 +104,7 @@
     public void execute() {
         Account owner = _accountService.getAccount(getEntityOwnerId());
         long ownerId = owner.getId();
-        boolean result = _ravService.removeVpnUser(ownerId, userName, CallContext.current().getCallingAccount());
+        boolean result = _ravService.removeVpnUser(owner, userName, CallContext.current().getCallingAccount());
         if (!result) {
             String errorMessage = String.format("Failed to remove VPN user=[%s]. VPN owner id=[%s].", userName, ownerId);
             logger.error(errorMessage);