Merge pull request #110 from adorsys/performance-test

implement performance testing

Author: Ogenbertrand

.env.template

@@ -7,6 +7,7 @@ APP_ENV=development # development | production
 APP_SERVER__HOST=0.0.0.0
 APP_SERVER__DOMAIN=statuslist.example.com
 APP_SERVER__PORT=8000
+APP_SERVER__ENABLE_METRICS=false
 
 # Certificate
 APP_SERVER__CERT__EMAIL=[email protected]

Cargo.toml

@@ -74,6 +74,8 @@ flate2 = "1.1"
 x509-parser = "0.18"
 public-suffix = "0.1"
 tokio-cron-scheduler = "0.15"
+metrics-exporter-prometheus = "0.17"
+metrics-process = "2.4"
 
 [dependencies.redis]
 version = "0.32"

artillery-tests/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+/scripts/ec-private-key.pem
+/scripts/ec-public-key.jwk
+/scripts/test-tokens.json

artillery-tests/how-to-run.md

@@ -0,0 +1,56 @@
+## How to run the performance test.
+
+In this tests we have 4 tests which are 
+ 1. Load test
+ 2. Stress test
+ 3. Spike test
+ 4. Athentication test
+
+ The main aim of each of these tests is to test the performance of the StatusList Server.
+
+### Step 1:
+
+Install artillery.
+```bash
+npm install -g artillery
+```
+### Step 3:
+
+The next step is to generate multiple test tokens that we can use during the performance test
+
+```bash
+# go to the test directory
+cd artillery-tests
+
+# Install dependencies
+npm install
+
+# run this
+npm run generate-tokens
+```
+### Step 4:
+
+Create an artillery account at [artillery.io](artillery.io). After creating the account, copy the access key, it should look like this `artillery run test.yml --record --key YOUR_ACCESS_KEY` on the welcome screen.
+
+### Step 5:
+
+Run the test.
+```bash
+ artillery run your_test.yml --name "stress-test" --record --key YOUR_ACCESS_KEY
+ ```
+
+## Memory and CPU usage
+
+Go to `localhost:9090` to access the prometheus dashboard. After that, search for the memory or cpu usage
+
+**Memory usage**: 
+```text
+process_resident_memory_bytes{job="status_list_server"} / 1024 / 1024
+```
+
+**CPU usage**: 
+```text
+rate(process_cpu_seconds_total[30s]) * 100
+```
+
+Click on graph to see the graph of each.