This project was inspired by a community driven challenge that ran on August 2023:
Challenge INSTRUCTIONS:
Challenge STRESS TEST
Unfortunatelly I only heard about it a few days after it was closed, but I decided to try it out here.
The API itself is not the challenge, but to make it fit within the confines of a measle 1.5 vCPU and 3GB of RAM, and endure a very heavy, almost DDoS-like Gatling stress test. It's brutal test.
The goal of this version was to make a fully Rails API based app, with enough speed optimizations without completely breaking the framework. Some tricks are not recommended for real production usage, but it leverages the fact that this is a performance oriented challenge.
To run this application:
docker-compose up
Just for the first time run:
docker-compose exec api1 rails db:create
docker-compose exec api1 rails db:migrate
Application should respond at:
http://0.0.0.0:9999
Run stress test:
wget https://repo1.maven.org/maven2/io/gatling/highcharts/gatling-charts-highcharts-bundle/3.9.5/gatling-charts-highcharts-bundle-3.9.5-bundle.zip
unzip gatling-charts-highcharts-bundle-3.9.5-bundle.zip
sudo mv gatling-charts-highcharts-bundle-3.9.5-bundle /opt
sudo ln -s /opt/gatling-charts-highcharts-bundle-3.9.5-bundle /opt/gatling
cd ..
git clone https://github.com/zanfranceschi/rinha-de-backend-2023-q3.git
cd rinha-de-backend-2023-q3/stress-test
Edit the stress-test run-test.sh variables accordingly:
GATLING_BIN_DIR=/opt/gatling/bin
WORKSPACE=$HOME/Projects/rinha-de-backend-2023-q3/stress-test
Run the stress test:
./run-test.sh # after docker-compose up
On AWS EC2, create a t2.medium instance (2vCPUs 4GB RAM), download the .pem key:
chmod 400 yourkey.pem
ssh -i yourkey.pem -o IdentitiesOnly=yes ec2-user@yourinstanceaddress.com
SSH in:
# Install Docker
sudo amazon-linux-extras install docker
sudo service docker start
sudo usermod -a -G docker ec2-user
# Install Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
# install Git
sudo yum update -y
sudo yum install git -y
git clone https://github.com/akitaonrails/rinhabackend-rails-api.git
# run docker compose
cd rinhabackend-rails-api
docker-compose up --force-recreate -d
Don't forget to change run-test.sh and RinhaBackendSimulation.scala to add your own PATH and HOST name (in case you're running on AWS EC2). Also don't forget to edit docker-compose.yml to not build locally, but fetch the image from docker.io.
And in case you're wondering how a more "realistic" setup would look like, I created a "docker-compose-ideal.yml" that breaks the 1.5 vCPU and 3GB of RAM to a whopping 24 vCPUs and 20GB of RAM. If you have the horsepower for that, run:
docker-compose -f docker-compose-ideal.yml up --force-recreate --build