feat - load testing added

README.md

@@ -6,6 +6,7 @@ This repository provides a template for creating and deploying a FastAPI project
 
 - [Features](#features)
 - [Getting started](#getting-started)
+- [Advanced Usage](#advanced-usage)
 
 ### Features
 
@@ -28,6 +29,8 @@ This repository provides a template for creating and deploying a FastAPI project
 - Application monitoring using Signoz
 - Feature flagging added - User can enabled/disabled
 - Database Monitoring using percona
+- Loadtests using locust
+
 ### Getting Started
 
 #### Requirements:
@@ -144,7 +147,9 @@ async def external_service_endpoint():
         raise HTTPException(status_code=503, detail="Service temporarily unavailable")
 ```
 
-# Using Signoz Monitoring Tool
+### Advanced Usage
+
+#### Using Signoz Monitoring Tool
 
 To utilize Signoz for monitoring your applications, follow these steps:
 
@@ -179,7 +184,7 @@ To utilize Signoz for monitoring your applications, follow these steps:
      OTEL_EXPORTER_OTLP_PROTOCOL=
      ```
 
-## Logging with Signoz
+#### Logging with Signoz
 
 To enable logging with Signoz, follow these steps:
 
@@ -196,7 +201,8 @@ To enable logging with Signoz, follow these steps:
    - Follow the instructions provided to configure log sending to Signoz.
 
 By following these steps, you can effectively set up application monitoring and logging using Signoz for your Python FastAPI applications.
-### Database Monitoring Using Percona
+
+#### Database Monitoring Using Percona
 
 To monitor your database using Percona, follow these steps:
 
@@ -230,8 +236,15 @@ To monitor your database using Percona, follow these steps:
 
 By following these steps, you'll successfully configure Percona to monitor your MySQL database.
 
-### Dashboard Links
+#### Dashboard Links
 - Percona: https://localhost:443
 - flower: http://localhost:5556
 - server: http://localhost:8000
+- locust: http://localhost:8089
 - server-healthcheck: http://localhost:8000/home
+
+
+#### Useful scripts
+- Tests - scripts/run_tests.sh
+- Linting & Formatting - scripts/lint_and_format.sh
+- Load tests - scripts/load_tests.sh (Change [locust.conf](https://docs.locust.io/en/stable/configuration.html) accordinly)

app/middlewares/rate_limiter_middleware.py

@@ -6,7 +6,7 @@
 
 from app.config.redis_config import get_redis_pool
 
-MAX_REQUESTS = 10
+MAX_REQUESTS = 10000
 TIME_WINDOW = 60
 
 

app/routes/users/users.py

@@ -12,7 +12,6 @@
 from app.daos.users import get_user as get_user_dao
 from app.daos.users import list_users as list_users_dao
 from app.daos.users import login as signin
-from app.middlewares.request_id_injection import request_id_contextvar
 from app.schemas.users.users_request import CreateUser
 from app.schemas.users.users_request import Login
 from app.schemas.users.users_response import UserOutResponse

compose.yaml

@@ -101,7 +101,22 @@ services:
       - /:/host:ro
     networks:
       - fast-api-network
-
+  locust-master:
+    image: locustio/locust
+    ports:
+      - "8089:8089"  # Expose Locust's web interface on port 8089
+    volumes:
+      - ./loadtests:/mnt/locust  # Mount the loadtests directory into the container
+    command: -f /mnt/locust --master -H http://app:"${SERVER_PORT}"  # Start Locust in master mode, pointing to your FastAPI application
+    networks:
+      - fast-api-network
+  locust-worker:
+    image: locustio/locust
+    volumes:
+      - ./loadtests:/mnt/locust  # Mount the loadtests directory into the container
+    command: -f /mnt/locust --worker --master-host locust-master
+    networks:
+      - fast-api-network
 networks:
   fast-api-network:
     driver: bridge

loadtests/home.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from locust import HttpUser
+from locust import task
+
+
+class Home(HttpUser):
+    @task
+    def home_endpoint(self):
+        self.client.get("/api/home/")

locust.conf

@@ -0,0 +1,8 @@
+locustfile = ./loadtests
+headless = true
+master = false
+expect-workers = 5
+host = http://0.0.0.0:8000
+users = 100
+spawn-rate = 10
+run-time = 10m

requirements.txt

@@ -43,6 +43,7 @@ iniconfig==2.0.0
 itsdangerous
 joblib==1.2.0
 langchain
+locust>=2.0
 lxml==4.9.2
 lz4==4.3.2
 Markdown==3.4.3

scripts/load_tests.sh

@@ -0,0 +1,3 @@
+echo "Running load tests"
+echo
+locust