optimizing

Author: sanderegg

tests/performance2/Makefile

@@ -33,14 +33,16 @@ DEFAULT_SPAWN_RATE := 1
 DEFAULT_RUN_TIME := 5m
 DEFAULT_HOST := http://127.0.0.1:9081
 
+# Default endpoint to test
+DEFAULT_ENDPOINT := /
+
 # Function to generate Locust configuration file
 # Usage: $(call generate_locust_config,filename_suffix,processes,users,spawn_rate,run_time,description)
 define generate_locust_config
 	@printf "$(YELLOW)Setting up $(2) configuration...$(NC)\n"
 	@echo "# Locust configuration file - $(5)" > $(LOCUST_CONFIG_FILE)$(1); \
 	echo "[locust]" >> $(LOCUST_CONFIG_FILE)$(1); \
-	echo "locustfile = ./locustfiles" >> $(LOCUST_CONFIG_FILE)$(1); \
-	echo "headless = true" >> $(LOCUST_CONFIG_FILE)$(1); \
+	echo "locustfile = ./locustfiles/deployment_max_rps_single_endpoint.py" >> $(LOCUST_CONFIG_FILE)$(1); \
 	if [ -f $(LOCUST_CONFIG_FILE) ]; then \
 		echo "host = $$(grep "host = " $(LOCUST_CONFIG_FILE) | cut -d= -f2 | xargs)" >> $(LOCUST_CONFIG_FILE)$(1); \
 	else \
@@ -69,11 +71,12 @@ define create_locust_config
 		run_time=$${run_time:-$(DEFAULT_RUN_TIME)}; \
 		read -p "Host to load test [$(DEFAULT_HOST)]: " host; \
 		host=$${host:-$(DEFAULT_HOST)}; \
+		read -p "Endpoint to test [$(DEFAULT_ENDPOINT)]: " endpoint; \
+		endpoint=$${endpoint:-$(DEFAULT_ENDPOINT)}; \
 		echo; \
 		echo "# Locust configuration file - Autogenerated" > $(LOCUST_CONFIG_FILE); \
 		echo "[locust]" >> $(LOCUST_CONFIG_FILE); \
-		echo "locustfile = deployment_max_rps_test.py" >> $(LOCUST_CONFIG_FILE); \
-		echo "headless = true" >> $(LOCUST_CONFIG_FILE); \
+		echo "locustfile = ./locustfiles/deployment_max_rps_single_endpoint.py" >> $(LOCUST_CONFIG_FILE); \
 		echo "host = $$host" >> $(LOCUST_CONFIG_FILE); \
 		echo "users = $$users" >> $(LOCUST_CONFIG_FILE); \
 		echo "spawn-rate = $$spawn_rate" >> $(LOCUST_CONFIG_FILE); \
@@ -104,22 +107,22 @@ define prompt_for_credentials
 endef
 
 
-test-deployment: _check_venv_active ## runs deployment test on deploy
+test-deployment: _check_venv_active ## runs deployment test on deploy, optionally pass endpoint=path to test specific endpoint
 	@$(call prompt_for_credentials)
 	@$(call create_locust_config)
 	@printf "$(YELLOW)Starting Locust...$(NC)\n"
 	@export $$(cat $(AUTH_CREDS_FILE) | xargs) && \
-	locust --config $(LOCUST_CONFIG_FILE)
+	locust --config $(LOCUST_CONFIG_FILE) $(if $(endpoint),--endpoint $(endpoint),--endpoint $(DEFAULT_ENDPOINT))
 
-test-deployment-ci: _check_venv_active ## runs deployment test on CI
+test-deployment-ci: _check_venv_active ## runs deployment test on CI, optionally pass endpoint=path to test specific endpoint
 	@$(call prompt_for_credentials)
 	@$(call create_locust_config)
 	@printf "$(YELLOW)Starting Locust headless...$(NC)\n"
 	@export $$(cat $(AUTH_CREDS_FILE) | xargs) && \
 	locust --config $(LOCUST_CONFIG_FILE) \
-		--headless
+		--headless $(if $(endpoint),--endpoint $(endpoint),--endpoint $(DEFAULT_ENDPOINT))
 
-test-deployment-with-grafana: _check_venv_active grafana-dashboards-up ## runs deployment test with Grafana integration
+test-deployment-with-grafana: _check_venv_active grafana-dashboards-up ## runs deployment test with Grafana integration, optionally pass endpoint=path to test specific endpoint
 	@$(call prompt_for_credentials)
 	@$(call create_locust_config)
 	@printf "$(YELLOW)Starting Locust with Grafana integration...$(NC)\n"
@@ -130,7 +133,7 @@ test-deployment-with-grafana: _check_venv_active grafana-dashboards-up ## runs d
 		--pgport $(PG_PORT) \
 		--pguser $(PG_USER) \
 		--pgpassword=$(PG_PASSWORD) \
-		--timescale
+		--timescale $(if $(endpoint),--endpoint $(endpoint),--endpoint $(DEFAULT_ENDPOINT))
 
 
 
@@ -164,11 +167,12 @@ update-locust-config: ## Update the Locust configuration file
 	run_time=$${run_time:-$(DEFAULT_RUN_TIME)}; \
 	read -p "Host to load test [$(DEFAULT_HOST)]: " host; \
 	host=$${host:-$(DEFAULT_HOST)}; \
+	read -p "Endpoint to test [$(DEFAULT_ENDPOINT)]: " endpoint; \
+	endpoint=$${endpoint:-$(DEFAULT_ENDPOINT)}; \
 	echo; \
 	echo "# Locust configuration file - Autogenerated" > $(LOCUST_CONFIG_FILE); \
 	echo "[locust]" >> $(LOCUST_CONFIG_FILE); \
-	echo "locustfile = deployment_max_rps_test.py" >> $(LOCUST_CONFIG_FILE); \
-	echo "headless = true" >> $(LOCUST_CONFIG_FILE); \
+	echo "locustfile = ./locustfiles/deployment_max_rps_single_endpoint.py" >> $(LOCUST_CONFIG_FILE); \
 	echo "host = $$host" >> $(LOCUST_CONFIG_FILE); \
 	echo "users = $$users" >> $(LOCUST_CONFIG_FILE); \
 	echo "spawn-rate = $$spawn_rate" >> $(LOCUST_CONFIG_FILE); \

tests/performance2/common/deploy_auth.py

@@ -6,3 +6,6 @@ class MonitoringBasicAuth(BaseSettings):
     model_config = SettingsConfigDict(extra="ignore")
     SC_USER_NAME: str = Field(default=..., examples=["<your username>"])
     SC_PASSWORD: str = Field(default=..., examples=["<your password>"])
+
+    def to_auth(self) -> tuple[str, str]:
+        return (self.SC_USER_NAME, self.SC_PASSWORD)

tests/performance2/locustfiles/deployment_max_rps_single_endpoint.py

@@ -1,32 +1,58 @@
 #
 # SEE https://docs.locust.io/en/stable/quickstart.html
 #
+# This script allows testing the maximum RPS against a single endpoint.
+# Usage:
+#   locust -f deployment_max_rps_single_endpoint.py --endpoint /v0/health
+#
+# If no endpoint is specified, the root endpoint ("/") will be used by default.
+#
 
 import logging
 
 import locust_plugins
 from common.deploy_auth import MonitoringBasicAuth
-from locust import task
+from locust import events, task
 from locust.contrib.fasthttp import FastHttpUser
 
 logging.basicConfig(level=logging.INFO)
 
-
 # NOTE: 'import locust_plugins' is necessary to use --check-fail-ratio
 # this assert is added to avoid that pycln pre-commit hook does not
 # remove the import (the tool assumes the import is not necessary)
 assert locust_plugins  # nosec
 
+# Use a mutable object to store endpoint
+_endpoint_holder = {"endpoint": "/"}
+
+
+def add_endpoint_argument(parser):
+    parser.add_argument(
+        "--endpoint",
+        type=str,
+        default="/",
+        help="The endpoint to test (e.g., /v0/health)",
+    )
+
+
+# Register the custom argument with Locust's parser
+@events.init_command_line_parser.add_listener
+def _(parser):
+    add_endpoint_argument(parser)
+
+
+@events.init.add_listener
+def _(environment, **_kwargs):
+    _endpoint_holder["endpoint"] = environment.parsed_options.endpoint
+    logging.info("Testing endpoint: %s", _endpoint_holder["endpoint"])
+
 
 class WebApiUser(FastHttpUser):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        _auth = MonitoringBasicAuth()
-        self.auth = (
-            _auth.SC_USER_NAME,
-            _auth.SC_PASSWORD,
-        )
+        self.auth = MonitoringBasicAuth().to_auth()
+        self.endpoint = _endpoint_holder["endpoint"]
 
     @task
-    def get_root(self):
-        self.client.get("", auth=self.auth)
+    def get_endpoint(self):
+        self.client.get(self.endpoint, auth=self.auth)