Starter template app for cloudgate.
This is useful if you need a Node.js Application server able to:
- Serving static files, REST APIs, Websockets ... all in one
- Full control over the whole pipeline with no middle man
- Multi-threaded with inter-thread communication & shared memory
- Crazy fast (check benchmarks below)
sudo apt -y install curl dirmngr apt-transport-https lsb-release ca-certificates
curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt -y install nodejs git
npx create-cloudgate-app my-app-1
This will create a full stack Node.js application supporting static files, REST API & Websockets endpoints.
OR
git clone https://github.com/elestio/cloudgate-app.git
cd cloudgate-app;
npm install;
- Add your static files in
/public/folder - Add or duplicate an api function in
/api/folder or subfolders - Reference your new functions in
/apiconfig.json
Sample basic API function (can be found in /api/tests/simple.js):
module.exports = async (event) => {
var myContent = "Hello World! " + (new Date().getTime())
return {
httpStatus: "200",
headers: {'content-type': 'text/html'},
content: myContent
};
};
REST API & Websocket functions receive an event object, here is an example:
{
"method": "GET",
"path": "/api/tests/simple",
"ip": "XXX.XXX.XXX.XXX",
"query": "myParam1=123",
"queryStringParameters": {
"myParam1": "123"
},
"headers": {
"host": "localhost:3000",
"connection": "keep-alive",
"cache-control": "max-age=0",
"user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36",
"accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
"accept-encoding": "gzip, deflate",
"accept-language": "fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7",
"cookie": "myCookie1=XXXXXXXXXXXXX;"
},
"GET": {
"myParam1": "123"
},
"body": null
"FILES": []
}
PORT=3000 node index.js
SSL=1 SSL_PORT=443 SSL_CERT=/path/to/cert.cer SSL_KEY=/path/to/cert.key node index.js
Run just once
docker build -t elestio/cloudgate-app .
docker run --rm -p 80:3000 -it elestio/cloudgate-app
Run as a docker service
systemctl enable docker; #enable docker at boot
docker run -p 80:3000 -it -d --name cloudgate-app --restart always elestio/cloudgate-app;
I used WRK for benchmarks, anything else will be too slow and will hit the limits of the benchmarking tool rather than cloudgate limits. More details about the great WRK: https://github.com/wg/wrk
You can run the whole benchmark suit on your computer like this:
./benchmarks.sh
My test configuration for the tests results below: AMD Ryzen 5 3600, 6 cores
> wrk -t6 -c256 http://127.0.0.1:3000/ --latency
--------------------------------------------
Running 10s test @ http://127.0.0.1:3000/
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.06ms 1.89ms 27.98ms 89.41%
Req/Sec 88.16k 19.46k 126.65k 55.00%
Latency Distribution
50% 255.00us
75% 1.02ms
90% 3.09ms
99% 9.23ms
5273106 requests in 10.05s, 3.18GB read
Requests/sec: 524742.35
Transfer/sec: 324.28MB
I runned the exact same test (same static html file) on nginx to get a point of comparison nginx is running on port 8080 on my server
> wrk -t6 -c256 http://127.0.0.1:8080/icg.html
--------------------------------------------
Running 10s test @ http://127.0.0.1:8080/icg.html
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.74ms 3.07ms 208.07ms 89.85%
Req/Sec 47.97k 9.38k 91.66k 69.83%
2867104 requests in 10.07s, 2.67GB read
Requests/sec: 284788.93
Transfer/sec: 271.31MB
> wrk -t6 -c256 http://127.0.0.1:3000/cloudgate128.png --latency
--------------------------------------------
Running 10s test @ http://127.0.0.1:3000/cloudgate128.png
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.49ms 2.58ms 32.23ms 87.76%
Req/Sec 65.91k 15.63k 95.35k 62.10%
Latency Distribution
50% 341.00us
75% 1.37ms
90% 4.83ms
99% 11.95ms
3939181 requests in 10.08s, 56.74GB read
Requests/sec: 390743.74
Transfer/sec: 5.63GB
I runned the exact same test (same static png file) on nginx to get a point of comparison nginx is running on port 8080 on my server
> wrk -t6 -c256 http://127.0.0.1:8080/cloudgate128.png
--------------------------------------------
Running 10s test @ http://127.0.0.1:8080/cloudgate128.png
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.80ms 3.11ms 207.78ms 89.77%
Req/Sec 44.71k 9.14k 73.43k 69.00%
2675720 requests in 10.05s, 38.65GB read
Requests/sec: 266202.28
Transfer/sec: 3.85GB
> wrk -t6 -c256 http://127.0.0.1:3000/api/tests/simple --latency
--------------------------------------------
Running 10s test @ http://127.0.0.1:3000/api/tests/simple
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.45ms 2.57ms 44.15ms 88.06%
Req/Sec 74.82k 19.55k 120.61k 65.17%
Latency Distribution
50% 292.00us
75% 1.43ms
90% 4.63ms
99% 11.90ms
4489094 requests in 10.09s, 3.16GB read
Requests/sec: 444811.04
Transfer/sec: 320.27MB
> wrk -t6 -c256 http://127.0.0.1:3000/api/tests/full --latency
--------------------------------------------
Running 10s test @ http://127.0.0.1:3000/api/tests/full
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.02ms 571.05us 19.19ms 82.27%
Req/Sec 41.70k 2.75k 68.99k 76.17%
Latency Distribution
50% 0.92ms
75% 1.24ms
90% 1.63ms
99% 2.69ms
2489466 requests in 10.04s, 2.45GB read
Requests/sec: 248071.03
Transfer/sec: 249.54MB
> wrk -t6 -c256 http://127.0.0.1:3000/api/tests/template --latency
--------------------------------------------
Running 10s test @ http://127.0.0.1:3000/api/tests/template
6 threads and 256 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.52ms 2.00ms 28.25ms 89.05%
Req/Sec 38.81k 5.42k 63.84k 73.12%
Latency Distribution
50% 778.00us
75% 1.70ms
90% 3.73ms
99% 10.01ms
2326046 requests in 10.09s, 3.18GB read
Requests/sec: 230525.88
Transfer/sec: 322.94MB