Nonlinear Workload - Calculate Number of Agents based on Total Ramp Rate and Max Users/Sec per Agent

api/src/main/java/com/intuit/tank/vm/vmManager/JobRequest.java

@@ -62,6 +62,11 @@ public interface JobRequest extends Serializable {
      */
     public abstract int getNumAgents();
 
+    /**
+     * @return the targetRatePerAgent
+     */
+    public abstract double getTargetRatePerAgent();
+
     /**
      * @return the location
      */

api/src/main/java/com/intuit/tank/vm/vmManager/JobRequestImpl.java

@@ -62,6 +62,7 @@ public final class JobRequestImpl implements Serializable, JobRequest {
     private String vmInstanceType;
     private int numUsersPerAgent;
     private int numAgents;
+    private double targetRatePerAgent;
     private int startRate;
     private double endRate;
     private String scriptsXmlUrl;
@@ -226,6 +227,21 @@ public void setNumAgents(int numAgents) {
         this.numAgents = numAgents;
     }
 
+    /**
+     * @return the targetRatePerAgent
+     */
+    public double getTargetRatePerAgent() {
+        return targetRatePerAgent;
+    }
+
+    /**
+     * @param targetRatePerAgent
+     *            the targetRatePerAgent to set
+     */
+    public void setTargetRatePerAgent(double targetRatePerAgent) {
+        this.targetRatePerAgent = targetRatePerAgent;
+    }
+
     /**
      * @return the startRate
      */
@@ -414,6 +430,12 @@ public GeneratorT withNumAgents(int aValue) {
             return (GeneratorT) this;
         }
 
+        @SuppressWarnings("unchecked")
+        public GeneratorT withTargetRatePerAgent(double aValue) {
+            instance.targetRatePerAgent = aValue;
+            return (GeneratorT) this;
+        }
+
         @SuppressWarnings("unchecked")
         public GeneratorT withStartRate(int aValue) {
             instance.startRate = aValue;

api/src/main/java/com/intuit/tank/vm/vmManager/JobVmCalculator.java

@@ -13,6 +13,8 @@
  * #L%
  */
 
+import java.math.BigDecimal;
+import java.math.RoundingMode;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.PriorityQueue;
@@ -33,6 +35,29 @@ public static int getMachinesForAgent(int numberOfUsers, int numUsersPerAgent) {
         return (int) Math.ceil((double) numberOfUsers / (double) numUsersPerAgent);
     }
 
+    /**
+     *
+     * @param targetRate
+     * @param targetRatePerAgent
+     * @return
+     */
+    public static Map<Integer, Double> getMachinesForAgentByTargetRate(double targetRate, Double targetRatePerAgent) {
+        Map<Integer, Double> agentAllocation = new HashMap<>();
+        if (targetRate <= 0.0 || targetRatePerAgent <= 0.0) {
+            return agentAllocation;
+        }
+
+        // divide the (target rate) by the (target rate per agent) to get the number of agents needed (always round up)
+        BigDecimal targetRateBD = BigDecimal.valueOf(targetRate);
+        BigDecimal targetRatePerAgentBD = BigDecimal.valueOf(targetRatePerAgent);
+        int numAgents = targetRateBD.divide(targetRatePerAgentBD, 2, RoundingMode.CEILING).setScale(0, RoundingMode.CEILING).intValue();
+
+        // adjusts the rate per agent if needed due to rounding up (always less than or equal to the initial rate per agent)
+        double ratePerAgent = targetRate / numAgents;
+
+        return Map.of(numAgents, ratePerAgent);
+    }
+
     /**
      *
      * @param totalAgents

data_model/src/main/java/com/intuit/tank/project/BaseJob.java

@@ -71,6 +71,9 @@ public abstract class BaseJob extends BaseEntity {
     @Column(name = "num_agents", columnDefinition = "INT(11) NOT NULL DEFAULT '1'")
     private int numAgents = 1;
 
+    @Column(name = "target_rate_per_agent", columnDefinition="DECIMAL(10,2) NOT NULL DEFAULT '1.00'")
+    private Double targetRatePerAgent = 1.00;
+
     @Column(name = "logging_profile")
     private String loggingProfile = LoggingProfile.STANDARD.name();
 
@@ -138,6 +141,7 @@ public BaseJob(BaseJob copy) {
         this.executionTime = copy.executionTime;
         this.numUsersPerAgent = copy.numUsersPerAgent;
         this.numAgents = copy.numAgents;
+        this.targetRatePerAgent = copy.targetRatePerAgent;
         this.vmInstanceType = copy.vmInstanceType;
         this.useEips = copy.useEips;
         this.useTwoStep = copy.useTwoStep;
@@ -372,6 +376,21 @@ public void setNumAgents(int numAgents) {
         this.numAgents = numAgents;
     }
 
+    /**
+     * @return the targetRatePerAgent
+     */
+    public Double getTargetRatePerAgent() {
+        return targetRatePerAgent;
+    }
+
+    /**
+     * @param targetRatePerAgent
+     *            the targetRatePerAgent to set
+     */
+    public void setTargetRatePerAgent(Double targetRatePerAgent) {
+        this.targetRatePerAgent = targetRatePerAgent;
+    }
+
     /**
      * @return the location
      */

rest-mvc/src/main/java/com/intuit/tank/rest/mvc/rest/util/JobDetailFormatter.java

@@ -82,7 +82,8 @@ protected static String buildDetails(JobValidator validator, Workload workload,
             addProperty(sb, "Assign Elastic Ips", Boolean.toString(proposedJobInstance.isUseEips()));
             addProperty(sb, "Enable Two-Step Job Start", Boolean.toString(proposedJobInstance.isUseTwoStep()));
             if(proposedJobInstance.getIncrementStrategy().equals(IncrementStrategy.standard)) {
-                addProperty(sb, "Number of Agents", Integer.toString(proposedJobInstance.getNumAgents()));
+                addProperty(sb, "Number of Agents", Integer.toString(JobVmCalculator.getMachinesForAgentByTargetRate(proposedJobInstance.getTargetRampRate(), proposedJobInstance.getTargetRatePerAgent()).keySet().iterator().next()));
+                addProperty(sb, "Max Users/Sec Per Agent", Double.toString(JobVmCalculator.getMachinesForAgentByTargetRate(proposedJobInstance.getTargetRampRate(), proposedJobInstance.getTargetRatePerAgent()).values().iterator().next()));
             } else {
                 addProperty(sb, "Max Users per Agent", Integer.toString(proposedJobInstance.getNumUsersPerAgent()));
             }
@@ -110,8 +111,7 @@ protected static String buildDetails(JobValidator validator, Workload workload,
             }
             addProperty(sb, "Ramp Time", TimeUtil.toTimeString(proposedJobInstance.getRampTime()));
             if(proposedJobInstance.getIncrementStrategy().equals(IncrementStrategy.standard)){
-                addProperty(sb, "Agent User Ramp Rate (users/sec)", String.format("%.2f", proposedJobInstance.getTargetRampRate()));
-                addProperty(sb, "Total User Ramp Rate (users/sec)", String.format("%.2f", proposedJobInstance.getTargetRampRate() * proposedJobInstance.getNumAgents()));
+                addProperty(sb, "Target Users Per Second",String.format("%.2f", proposedJobInstance.getTargetRampRate()));
                 addProperty(sb, "Estimated Steady State Concurrent Users",
                         String.format("%.2f", proposedJobInstance.getTargetRampRate() *
                                 ((double) proposedJobInstance.getRampTime() / 1000) *
@@ -148,7 +148,8 @@ protected static String buildDetails(JobValidator validator, Workload workload,
 
                 // Calculate number of agents per region split for nonlinear workloads
                 Set<RegionRequest> regionRequests = new HashSet<>(regions);
-                Map<RegionRequest, Integer> regionAllocation = JobVmCalculator.getMachinesForAgentByUserPercentage(proposedJobInstance.getNumAgents(), regionRequests);
+                int numAgents = JobVmCalculator.getMachinesForAgentByTargetRate(proposedJobInstance.getTargetRampRate(), proposedJobInstance.getTargetRatePerAgent()).keySet().iterator().next();
+                Map<RegionRequest, Integer> regionAllocation = JobVmCalculator.getMachinesForAgentByUserPercentage(numAgents, regionRequests);
 
                 int regionPercentage = 0;
                 for (JobRegion r : regions) {

tank_vmManager/src/main/java/com/intuit/tank/perfManager/workLoads/JobManager.java

@@ -171,7 +171,7 @@ public AgentTestStartData registerAgentForJob(AgentData agentData) {
                 ret.setTotalAgents(jobInfo.numberOfMachines);
                 ret.setIncrementStrategy(jobInfo.jobRequest.getIncrementStrategy());
                 ret.setUserIntervalIncrement(jobInfo.jobRequest.getUserIntervalIncrement());
-                ret.setTargetRampRate(jobInfo.jobRequest.getEndRate());
+                ret.setTargetRampRate(jobInfo.jobRequest.getTargetRatePerAgent());
                 jobInfo.agentData.add(agentData);
                 CloudVmStatus status = vmTracker.getStatus(agentData.getInstanceId());
                 if(status != null) {

tank_vmManager/src/main/java/com/intuit/tank/perfManager/workLoads/WorkLoadFactory.java

@@ -16,6 +16,7 @@
 import java.util.HashSet;
 import java.util.Set;
 
+import com.intuit.tank.vm.vmManager.*;
 import jakarta.inject.Inject;
 
 import com.intuit.tank.vm.api.enumerated.IncrementStrategy;
@@ -39,11 +40,6 @@
 import com.intuit.tank.vm.api.enumerated.VMRegion;
 import com.intuit.tank.vm.api.service.v1.project.ProjectServiceUrlBuilder;
 import com.intuit.tank.vm.scheduleManager.AgentDispatcher;
-import com.intuit.tank.vm.vmManager.JobRequest;
-import com.intuit.tank.vm.vmManager.JobRequestImpl;
-import com.intuit.tank.vm.vmManager.Notification;
-import com.intuit.tank.vm.vmManager.RegionRequest;
-import com.intuit.tank.vm.vmManager.VMChannel;
 import com.intuit.tank.vm.vmManager.JobRequestImpl.Builder;
 
 public class WorkLoadFactory {
@@ -139,7 +135,8 @@ private JobRequest jobToJobRequest(JobInstance job) {
                 .withUseTwoStep(job.isUseTwoStep())
                 .withVmInstanceType(job.getVmInstanceType())
                 .withnumUsersPerAgent(job.getNumUsersPerAgent())
-                .withNumAgents(job.getNumAgents())
+                .withNumAgents(JobVmCalculator.getMachinesForAgentByTargetRate(job.getTargetRampRate(), job.getTargetRatePerAgent()).keySet().iterator().next())
+                .withTargetRatePerAgent(JobVmCalculator.getMachinesForAgentByTargetRate(job.getTargetRampRate(), job.getTargetRatePerAgent()).values().iterator().next())
                 .withSimulationTime(job.getSimulationTime()).withStatus(job.getStatus())
                 .withTerminationPolicy(job.getTerminationPolicy())
                 .withUserIntervalIncrement(job.getUserIntervalIncrement())

web/web_support/src/main/java/com/intuit/tank/project/JobDetailFormatter.java

@@ -88,7 +88,8 @@ protected static String buildDetails(JobValidator validator, Workload workload,
             addProperty(sb, "Assign Elastic Ips", Boolean.toString(proposedJobInstance.isUseEips()));
             addProperty(sb, "Enable Two-Step Job Start", Boolean.toString(proposedJobInstance.isUseTwoStep()));
             if(proposedJobInstance.getIncrementStrategy().equals(IncrementStrategy.standard)) {
-                addProperty(sb, "Number of Agents", Integer.toString(proposedJobInstance.getNumAgents()));
+                addProperty(sb, "Number of Agents", Integer.toString(JobVmCalculator.getMachinesForAgentByTargetRate(proposedJobInstance.getTargetRampRate(), proposedJobInstance.getTargetRatePerAgent()).keySet().iterator().next()));
+                addProperty(sb, "Max Users/Sec Per Agent", Double.toString(JobVmCalculator.getMachinesForAgentByTargetRate(proposedJobInstance.getTargetRampRate(), proposedJobInstance.getTargetRatePerAgent()).values().iterator().next()));
             } else {
                 addProperty(sb, "Max Users per Agent", Integer.toString(proposedJobInstance.getNumUsersPerAgent()));
             }
@@ -116,8 +117,7 @@ protected static String buildDetails(JobValidator validator, Workload workload,
             }
             addProperty(sb, "Ramp Time", TimeUtil.toTimeString(proposedJobInstance.getRampTime()));
             if(proposedJobInstance.getIncrementStrategy().equals(IncrementStrategy.standard)){
-                addProperty(sb, "Agent User Ramp Rate (users/sec)",String.format("%.2f", proposedJobInstance.getTargetRampRate()));
-                addProperty(sb, "Total User Ramp Rate (users/sec)", String.format("%.2f", proposedJobInstance.getTargetRampRate() * proposedJobInstance.getNumAgents()));
+                addProperty(sb, "Target Users Per Second",String.format("%.2f", proposedJobInstance.getTargetRampRate()));
                 addProperty(sb, "Estimated Steady State Concurrent Users",
                         String.format("%.2f", proposedJobInstance.getTargetRampRate() *
                                 ((double) proposedJobInstance.getRampTime() / 1000) *
@@ -154,7 +154,8 @@ protected static String buildDetails(JobValidator validator, Workload workload,
 
                 // Calculate number of agents per region split for nonlinear workloads
                 Set<RegionRequest> regionRequests = new HashSet<>(regions);
-                Map<RegionRequest, Integer> regionAllocation = JobVmCalculator.getMachinesForAgentByUserPercentage(proposedJobInstance.getNumAgents(), regionRequests);
+                int numAgents = JobVmCalculator.getMachinesForAgentByTargetRate(proposedJobInstance.getTargetRampRate(), proposedJobInstance.getTargetRatePerAgent()).keySet().iterator().next();
+                Map<RegionRequest, Integer> regionAllocation = JobVmCalculator.getMachinesForAgentByUserPercentage(numAgents, regionRequests);
 
                 int regionPercentage = 0;
                 for (JobRegion r : regions) {

web/web_support/src/main/java/com/intuit/tank/project/JobMaker.java

@@ -238,6 +238,17 @@ public void setNumUsersPerAgent(int numUsers) {
         }
     }
 
+    public double getTargetRatePerAgent() {
+        return (projectBean.getJobConfiguration().getTargetRatePerAgent() != null) ?
+                projectBean.getJobConfiguration().getTargetRatePerAgent() : 1.00 ;
+    }
+
+    public void setTargetRatePerAgent(double targetRatePerAgent) {
+        if (targetRatePerAgent > 0.0) {
+            projectBean.getJobConfiguration().setTargetRatePerAgent(targetRatePerAgent);
+        }
+    }
+
     public int getNumAgents() {
         return projectBean.getJobConfiguration().getNumAgents();
     }

web/web_ui/src/main/webapp/projects/addWorkloadToJobQueue.xhtml

@@ -95,15 +95,15 @@
               <h:outputLabel for="numUsersPerInstance"
                              value="Max Users Per Agent"
                              styleClass="formLabel required" rendered="#{usersAndTimes.incrementStrategy == 'increasing'}"/>
-              <h:outputLabel for="numAgents"
-                             value="Number of Agents"
+              <h:outputLabel for="targetRatePerAgent"
+                             value="Max Users/Sec Per Agent"
                              styleClass="formLabel required" rendered="#{usersAndTimes.incrementStrategy == 'standard'}"/>
             </div>
             <div class="formInputDiv">
               <p:inputText id="numUsersPerInstance"
                            value="#{jobMaker.numUsersPerAgent}" rendered="#{usersAndTimes.incrementStrategy == 'increasing'}"/>
-              <p:inputText id="numAgents"
-                           value="#{jobMaker.numAgents}" rendered="#{usersAndTimes.incrementStrategy == 'standard'}"/>
+              <p:inputText id="targetRatePerAgent"
+                           value="#{jobMaker.targetRatePerAgent}" rendered="#{usersAndTimes.incrementStrategy == 'standard'}"/>
             </div>
           </div>
 

web/web_ui/src/main/webapp/projects/projectview.xhtml

@@ -123,22 +123,21 @@
           <div class="formRow">
             <div class="formLabelDiv">
               <h:outputText value="Total Users" styleClass="formLabel" rendered="#{usersAndTimes.incrementStrategy == 'increasing'}"/>
-              <h:outputText value="Agent User Ramp Rate (users/sec)" styleClass="formLabel" rendered="#{usersAndTimes.incrementStrategy == 'standard'}"/>
+              <h:outputText value="Target Users Per Second" styleClass="formLabel" rendered="#{usersAndTimes.incrementStrategy == 'standard'}"/>
             </div>
             <div class="formInputDiv">
               <h:outputText value="#{usersAndTimes.totalUsers}" id="totalUsersTF" rendered="#{usersAndTimes.incrementStrategy == 'increasing'}"/>
               <p:inplace label="#{usersAndTimes.endRate}" editor="true" rendered="#{usersAndTimes.incrementStrategy == 'standard'}">
                 <h:inputText id="endRateTF"
                              value="#{usersAndTimes.endRate}"
                              styleClass="formInput inputWidthSmall" required="true"
-                             requiredMessage="Agent User Ramp Rate cannot be empty." rendered="#{usersAndTimes.incrementStrategy == 'standard'}">
+                             requiredMessage="Target Users Per Second cannot be empty." rendered="#{usersAndTimes.incrementStrategy == 'standard'}">
                 </h:inputText>
                 <p:ajax event="save" update=":mainForm:endRateTF" rendered="#{usersAndTimes.incrementStrategy == 'standard'}" />
               </p:inplace>
               <ts:tip tipId="targetRampTip"
-                      text="Agent User Ramp Rate dictates the ending ramp rate in users/sec set for each agent for the nonlinear user ramp. This
-                            will inject users at regular intervals from the starting rate of 0 users/sec to the target rate of up to 1 user/sec for the provided ramp duration.
-                            The Total User Ramp Rate of the job is determined by the Agent User Ramp Rate times the Number of Agents i.e 1 user/sec * 10 agents = 10 users/sec" rendered="#{usersAndTimes.incrementStrategy == 'standard'}" />
+                      text="Target Users Per Second dictates the target user ramp rate in users/sec set for the nonlinear user ramp. This
+                            will inject users at regular intervals from the starting rate of 0 users/sec to the target rate of X user/sec during the provided ramp duration." rendered="#{usersAndTimes.incrementStrategy == 'standard'}" />
             </div>
           </div>
         </div>