Customization Feature for Percentile Display on Statistics Page

.gitignore

@@ -27,3 +27,4 @@ __pycache__
 .sass-cache/
 .env
 yarn-error.log
+.venv

docs/configuration.rst

@@ -203,4 +203,6 @@ The list of statistics parameters that can be modified is:
 +-------------------------------------------+--------------------------------------------------------------------------------------+
 | PERCENTILES_TO_CHART                      | The list of response time percentiles for response time chart                        |
 +-------------------------------------------+--------------------------------------------------------------------------------------+
+| PERCENTILES_TO_STATISTICS                 | The list of response time percentiles for response time statistics                   |
++-------------------------------------------+--------------------------------------------------------------------------------------+
 

locust/stats.py

@@ -127,6 +127,7 @@ def resize_handler(signum: int, frame: FrameType | None):
 
 PERCENTILES_TO_REPORT = [0.50, 0.66, 0.75, 0.80, 0.90, 0.95, 0.98, 0.99, 0.999, 0.9999, 1.0]
 
+PERCENTILES_TO_STATISTICS = [0.95, 0.99]
 PERCENTILES_TO_CHART = [0.50, 0.95]
 MODERN_UI_PERCENTILES_TO_CHART = [0.95]
 
@@ -681,6 +682,11 @@ def _cache_response_times(self, t: int) -> None:
                 self.response_times_cache.popitem(last=False)
 
     def to_dict(self, escape_string_values=False):
+        response_time_percentiles = {
+            f"response_time_percentile_{percentile}": self.get_response_time_percentile(percentile)
+            for percentile in PERCENTILES_TO_STATISTICS
+        }
+
         return {
             "method": escape(self.method or "") if escape_string_values else self.method,
             "name": escape(self.name) if escape_string_values else self.name,
@@ -693,8 +699,7 @@ def to_dict(self, escape_string_values=False):
             "current_rps": self.current_rps,
             "current_fail_per_sec": self.current_fail_per_sec,
             "median_response_time": self.median_response_time,
-            "ninetieth_response_time": self.get_response_time_percentile(0.9),
-            "ninety_ninth_response_time": self.get_response_time_percentile(0.99),
+            **response_time_percentiles,
             "avg_content_length": self.avg_content_length,
         }
 

locust/templates/index.html

@@ -191,10 +191,9 @@ <h2>Edit running load test</h2>
                             <th class="stats_label numeric nowrap" href="#" data-sortkey="num_requests" title="Number of requests"># Requests</th>
                             <th class="stats_label numeric nowrap" href="#" data-sortkey="num_failures" title="Number of failures"># Fails</th>
                             <th class="stats_label numeric" href="#" data-sortkey="median_response_time" title="Median response time">Median (ms)</th>
-                            <th class="stats_label numeric" href="#" data-sortkey="ninetieth_response_time" title="Ninetieth percentile response time, because the response time greater than 100ms is rounded, you may see it greater than the max response time">90%ile (ms)</th>
-                            <th class="stats_label numeric" href="#" data-sortkey="ninety_ninth_response_time"
-                                title="Ninety-ninth percentile response time, because the response time greater than 100ms is rounded, you may see it greater than the max response time">
-                                99%ile (ms)</th>
+                            {% for percentile in percentiles_to_statistics %}
+                                <th class="stats_label numeric" href="#" data-sortkey="{{percentile}}_response_time" title="{{percentile}} percentile response time, because the response time greater than 100ms is rounded, you may see it greater than the max response time">{{percentile}}%ile (ms)</th>
+                            {% endfor %}
                             <th class="stats_label numeric" href="#" data-sortkey="avg_response_time" title="Average response time">Average (ms)</th>
                             <th class="stats_label numeric" href="#" data-sortkey="min_response_time" title="Min response time">Min (ms)</th>
                             <th class="stats_label numeric" href="#" data-sortkey="max_response_time" title="Max response time">Max (ms)</th>
@@ -319,8 +318,11 @@ <h2>Version <a href="https://github.com/locustio/locust/releases/tag/{{version}}
             <td class="numeric"><%= this.num_requests %></td>
             <td class="numeric"><%= this.num_failures %></td>
             <td class="numeric"><%= Math.round(this.median_response_time) %></td>
-            <td class="numeric"><%= Math.round(this.ninetieth_response_time) %></td>
-            <td class="numeric"><%= Math.round(this.ninety_ninth_response_time) %></td>
+            <% for (const [key, value] of Object.entries(this)) { %>
+                <% if (key.startsWith("response_time_percentile")) { %>
+                    <td class="numeric"><%= Math.round(value) %></td>
+                <% } %>
+            <% } %>
             <td class="numeric"><%= Math.round(this.avg_response_time) %></td>
             <td class="numeric"><%= this.min_response_time %></td>
             <td class="numeric"><%= this.max_response_time %></td>

locust/test/test_main.py

@@ -233,6 +233,32 @@ def my_task(self):
             stdout, stderr = proc.communicate()
             self.assertIn("Starting web interface at", stderr)
 
+    def test_percentiles_to_statistics(self):
+        port = get_free_tcp_port()
+        with temporary_file(
+            content=textwrap.dedent(
+                """
+                from locust import User, task, constant, events
+                from locust.stats import PERCENTILES_TO_STATISTICS
+                PERCENTILES_TO_STATISTICS = [0.9, 0.99]
+                class TestUser(User):
+                    wait_time = constant(3)
+                    @task
+                    def my_task(self):
+                        print("running my_task()")
+            """
+            )
+        ) as file_path:
+            proc = subprocess.Popen(
+                ["locust", "-f", file_path, "--web-port", str(port), "--autostart"], stdout=PIPE, stderr=PIPE, text=True
+            )
+            gevent.sleep(1)
+            response = requests.get(f"http://localhost:{port}/")
+            self.assertEqual(200, response.status_code)
+            proc.send_signal(signal.SIGTERM)
+            stdout, stderr = proc.communicate()
+            self.assertIn("Starting web interface at", stderr)
+
     def test_invalid_percentile_parameter(self):
         with temporary_file(
             content=textwrap.dedent(

locust/test/test_util.py

@@ -1,6 +1,6 @@
 import unittest
 from locust.util.timespan import parse_timespan
-from locust.util.rounding import proper_round
+from locust.util.rounding import proper_round, normalize_decimal
 
 
 class TestParseTimespan(unittest.TestCase):
@@ -30,3 +30,8 @@ def test_rounding_up(self):
         self.assertEqual(4, proper_round(3.5))
         self.assertEqual(5, proper_round(4.5))
         self.assertEqual(6, proper_round(5.5))
+
+    def test_normalize_decimal(self):
+        self.assertEqual(1, normalize_decimal(1))
+        self.assertEqual(0.99, normalize_decimal(0.99))
+        self.assertEqual("a", normalize_decimal("a"))

locust/util/rounding.py

@@ -1,2 +1,9 @@
 def proper_round(val, digits=0):
     return round(val + 10 ** (-len(str(val)) - 1), digits)
+
+
+def normalize_decimal(value):
+    if isinstance(value, float) and value.is_integer():
+        return int(value)
+    else:
+        return value

locust/web.py

@@ -37,6 +37,7 @@
 from .util.timespan import parse_timespan
 from .html import get_html_report
 from flask_cors import CORS
+from .util.rounding import normalize_decimal
 
 if TYPE_CHECKING:
     from .env import Environment
@@ -613,11 +614,16 @@ def update_template_args(self):
         if self.modern_ui:
             percentiles = {
                 "percentiles_to_chart": stats_module.MODERN_UI_PERCENTILES_TO_CHART,
+                "percentiles_to_statistics": stats_module.PERCENTILES_TO_STATISTICS,
             }
         else:
             percentiles = {
                 "percentile1": stats_module.PERCENTILES_TO_CHART[0],
                 "percentile2": stats_module.PERCENTILES_TO_CHART[1],
+                # Convert percentiles to percent notation for use in templates
+                "percentiles_to_statistics": [
+                    normalize_decimal(percentile * 100) for percentile in stats_module.PERCENTILES_TO_STATISTICS
+                ],
             }
 
         self.template_args = {

locust/webui/dist/auth.html

@@ -7,7 +7,7 @@
     <meta name="theme-color" content="#000000" />
 
     <title>Locust</title>
-    <script type="module" crossorigin src="/assets/index-ea7131ad.js"></script>
+    <script type="module" crossorigin src="/assets/index-fd9ede73.js"></script>
   </head>
   <body>
     <div id="root"></div>

locust/webui/dist/index.html

@@ -7,7 +7,7 @@
     <meta name="theme-color" content="#000000" />
 
     <title>Locust</title>
-    <script type="module" crossorigin src="/assets/index-ea7131ad.js"></script>
+    <script type="module" crossorigin src="/assets/index-fd9ede73.js"></script>
   </head>
   <body>
     <div id="root"></div>

locust/webui/src/components/StatsTable/StatsTable.tsx

@@ -1,18 +1,25 @@
 import { connect } from 'react-redux';
 
 import Table from 'components/Table/Table';
+import { swarmTemplateArgs } from "constants/swarm";
 import useSortByField from 'hooks/useSortByField';
 import { IRootState } from 'redux/store';
 import { ISwarmStat } from 'types/ui.types';
 
+const percentilesToStatisticsRows = swarmTemplateArgs.percentilesToStatistics
+    ? swarmTemplateArgs.percentilesToStatistics.map(percentile => ({
+      title: `${percentile * 100}%ile (ms)`,
+      key: `responseTimePercentile${percentile}` as keyof ISwarmStat,
+    }))
+    : [];
+
 const tableStructure = [
   { key: 'method', title: 'Type' },
   { key: 'name', title: 'Name' },
   { key: 'numRequests', title: '# Requests' },
   { key: 'numFailures', title: '# Fails' },
   { key: 'medianResponseTime', title: 'Median (ms)', round: 2 },
-  { key: 'ninetiethResponseTime', title: '90%ile (ms)' },
-  { key: 'ninetyNinthResponseTime', title: '99%ile (ms)' },
+  ...percentilesToStatisticsRows,
   { key: 'avgResponseTime', title: 'Average (ms)', round: 2 },
   { key: 'minResponseTime', title: 'Min (ms)' },
   { key: 'maxResponseTime', title: 'Max (ms)' },

locust/webui/src/redux/slice/swarm.slice.ts

@@ -21,6 +21,7 @@ export interface ISwarmState {
   numUsers: number | null;
   overrideHostWarning: boolean;
   percentilesToChart: number[];
+  percentilesToStatistics: number[];
   runTime?: string | number;
   showUserclassPicker: boolean;
   spawnRate: number | null;

locust/webui/src/test/mocks/statsRequest.mock.ts

@@ -24,8 +24,8 @@ export const statsResponseMock = {
       method: 'GET',
       min_response_time: 0.0,
       name: '/',
-      ninetieth_response_time: 0,
-      ninety_ninth_response_time: 1,
+      "response_time_percentile_0.9": 0,
+      "response_time_percentile_0.99": 1,
       num_failures: 12652,
       num_requests: 12652,
       safe_name: '/',
@@ -40,8 +40,8 @@ export const statsResponseMock = {
       method: '',
       min_response_time: 0.0,
       name: 'Aggregated',
-      ninetieth_response_time: 0,
-      ninety_ninth_response_time: 1,
+      "response_time_percentile_0.9": 0,
+      "response_time_percentile_0.99": 1,
       num_failures: 12652,
       num_requests: 12652,
       safe_name: 'Aggregated',
@@ -113,8 +113,8 @@ export const statsResponseTransformed = {
       method: 'GET',
       minResponseTime: 0,
       name: '/',
-      ninetiethResponseTime: 0,
-      ninetyNinthResponseTime: 1,
+      "responseTimePercentile0.9": 0,
+      "responseTimePercentile0.99": 1,
       numFailures: 12652,
       numRequests: 12652,
       safeName: '/',
@@ -129,8 +129,8 @@ export const statsResponseTransformed = {
       method: '',
       minResponseTime: 0,
       name: 'Aggregated',
-      ninetiethResponseTime: 0,
-      ninetyNinthResponseTime: 1,
+      "responseTimePercentile0.9": 0,
+      "responseTimePercentile0.99": 1,
       numFailures: 12652,
       numRequests: 12652,
       safeName: 'Aggregated',

locust/webui/src/test/mocks/swarmState.mock.ts

@@ -1,4 +1,5 @@
 export const percentilesToChart = [0.5, 0.95];
+export const percentilesToStatistics = [0.5, 0.95, 0.99];
 
 export const swarmStateMock = {
   availableShapeClasses: ['Default'],
@@ -13,6 +14,7 @@ export const swarmStateMock = {
   overrideHostWarning: false,
   percentile1: 0.95,
   percentile2: 0.99,
+  percentilesToStatistics: percentilesToStatistics,
   showUserclassPicker: false,
   spawnRate: null,
   state: 'ready',

locust/webui/src/types/swarm.types.ts

@@ -47,4 +47,5 @@ export interface IReportTemplateArgs extends IReport {
   history: IHistory[];
   isReport?: boolean;
   percentilesToChart: number[];
+  percentilesToStatistics: number[];
 }

locust/webui/src/types/ui.types.ts

@@ -12,8 +12,7 @@ export interface ISwarmStat {
   method: 'GET' | 'POST' | 'PUT' | 'DELETE';
   minResponseTime: number;
   name: string;
-  ninetiethResponseTime: number;
-  ninetyNinthResponseTime: number;
+  [key: `responseTimePercentile${number}`]: number;
   numFailures: number;
   numRequests: number;
   safeName: string;