supabench

Platform to run and keep the history of benchmark runs.

References

• Supabase - Built by Supabase team.
• Pocketbase - This project uses Pocketbase as a backend, and the frontend is also based on the Pocketbase admin UI.
• k6 - The load generator used.
• Terraform - SUT and loader infrastructure delivery.
• Grafana - Dashboard for benchmark results.
• Prometheus - Store metrics for benchmark results.
• Telegraf - Send benchmark metrics to Prometheus.

Uploading Benchmarks to Supabench

To upload a benchmark to supabench, you need to create a zip archive of your benchmark folder.

How to Create a Zip Archive

1. Navigate to your benchmark folder (e.g., examples/realtime/broadcast-from-client)

2. Create a zip file containing all the files in the folder:

   # From inside the benchmark folder
   zip -r benchmark.zip .

3. Upload the zip file through the supabench UI when creating or updating a benchmark secret.

Example Structure

Your zip file should contain a structure like this:

benchmark.zip
├── main.tf
├── variables.tf
├── k6/
│   ├── common.js
│   ├── subs.js
│   ├── Makefile
│   └── summary.js
└── modules/
    └── script/
        ├── main.tf
        ├── variables.tf
        └── entrypoint.sh.tpl

More Info

More information about the project can be found on the Github Wiki