Updated api & release notes for ips functions

docs/api.rst

@@ -44,7 +44,7 @@ Built in wait_time functions
 ============================
 
 .. automodule:: locust.wait_time
-    :members: between, constant, constant_pacing
+    :members: between, constant, constant_pacing, constant_ips, constant_ips_total
 
 HttpSession class
 =================

docs/changelog.rst

@@ -9,7 +9,7 @@ In development (master)
 
 * Continuously measure CPU usage and emit a warning if we get a five second average above 90%
 * Show CPU usage of slave nodes in the Web UI
-
+* Add new timers that target iterations per second: constant_ips (the inverse of constant_pacing) and constant_ips_total (total iterations per second, across locusts)
 
 0.13.5
 ======

locust/runners.py

@@ -41,6 +41,7 @@ def __init__(self, locust_classes, options):
         self.state = STATE_INIT
         self.hatching_greenlet = None
         self.stepload_greenlet = None
+        self.target_user_count = None
         self.current_cpu_usage = 0
         self.cpu_warning_emitted = False
         self.ips_warning_emitted = False
@@ -216,6 +217,7 @@ def start_hatching(self, locust_count, hatch_rate, wait=False):
             self.exceptions = {}
             self.cpu_warning_emitted = False
             self.slave_cpu_warning_emitted = False
+            self.target_user_count = locust_count
             events.locust_start_hatching.fire()
 
         # Dynamically changing the locust count
@@ -298,6 +300,7 @@ def on_locust_error(locust_instance, exception, tb):
         events.locust_error += on_locust_error
 
     def start_hatching(self, locust_count, hatch_rate, wait=False):
+        self.target_user_count = locust_count
         if hatch_rate > 100:
             logger.warning("Your selected hatch rate is very high (>100), and this is known to sometimes cause issues. Do you really need to ramp up that fast?")
         if self.hatching_greenlet:
@@ -329,7 +332,6 @@ class MasterLocustRunner(DistributedLocustRunner):
     def __init__(self, *args, **kwargs):
         super(MasterLocustRunner, self).__init__(*args, **kwargs)
         self.slave_cpu_warning_emitted = False
-        self.target_user_count = None
 
         class SlaveNodesDict(dict):
             def get_by_state(self, state):

locust/wait_time.py

@@ -95,11 +95,11 @@ def wait_time_func(self):
             )
             return 1.0 / ips
         current_time = float(time())
-        unstarted_clients = lr.num_clients - len(lr.locusts)
+        unstarted_clients = lr.target_user_count - lr.user_count
         if not hasattr(self, "_cp_last_run"):
             self._cp_last_run = 0
             self._cp_target_missed = False
-        next_time = self._cp_last_run + (lr.num_clients + unstarted_clients) / float(ips)
+        next_time = self._cp_last_run + (lr.target_user_count + unstarted_clients) / float(ips)
         if current_time > next_time:
             if lr.state == runners.STATE_RUNNING and self._cp_target_missed and not lr.ips_warning_emitted:
                 logging.warning("Failed to reach target ips, even after rampup has finished")