chore: add example for benchmarks

[Uzlopak]

adding example as a potential approach to add benchmarks.

This is also to show the performance difference between latest 12 and our 13 beta branch:

v12

Running 10s test @ http://127.0.0.1:3000/
10 connections


┌─────────┬───────┬───────┬───────┬───────┬──────────┬─────────┬────────┐
│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%   │ Avg      │ Stdev   │ Max    │
├─────────┼───────┼───────┼───────┼───────┼──────────┼─────────┼────────┤
│ Latency │ 18 ms │ 24 ms │ 50 ms │ 56 ms │ 26.16 ms │ 9.89 ms │ 152 ms │
└─────────┴───────┴───────┴───────┴───────┴──────────┴─────────┴────────┘
┌───────────┬───────┬───────┬─────────┬─────────┬─────────┬─────────┬───────┐
│ Stat      │ 1%    │ 2.5%  │ 50%     │ 97.5%   │ Avg     │ Stdev   │ Min   │
├───────────┼───────┼───────┼─────────┼─────────┼─────────┼─────────┼───────┤
│ Req/Sec   │ 360   │ 360   │ 373     │ 387     │ 374.1   │ 8.37    │ 360   │
├───────────┼───────┼───────┼─────────┼─────────┼─────────┼─────────┼───────┤
│ Bytes/Sec │ 45 kB │ 45 kB │ 46.7 kB │ 48.4 kB │ 46.8 kB │ 1.04 kB │ 45 kB │
└───────────┴───────┴───────┴─────────┴─────────┴─────────┴─────────┴───────┘

Req/Bytes counts sampled once per second.
# of samples: 10

4k requests in 10.02s, 468 kB read

beta/v13

Running 10s test @ http://127.0.0.1:3000/
10 connections


┌─────────┬──────┬──────┬───────┬──────┬─────────┬─────────┬───────┐
│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%  │ Avg     │ Stdev   │ Max   │
├─────────┼──────┼──────┼───────┼──────┼─────────┼─────────┼───────┤
│ Latency │ 1 ms │ 1 ms │ 4 ms  │ 5 ms │ 1.32 ms │ 0.88 ms │ 33 ms │
└─────────┴──────┴──────┴───────┴──────┴─────────┴─────────┴───────┘
┌───────────┬────────┬────────┬────────┬────────┬────────┬────────┬────────┐
│ Stat      │ 1%     │ 2.5%   │ 50%    │ 97.5%  │ Avg    │ Stdev  │ Min    │
├───────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┤
│ Req/Sec   │ 3957   │ 3957   │ 6675   │ 6735   │ 6337.5 │ 810.87 │ 3956   │
├───────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┤
│ Bytes/Sec │ 495 kB │ 495 kB │ 834 kB │ 842 kB │ 792 kB │ 101 kB │ 495 kB │
└───────────┴────────┴────────┴────────┴────────┴────────┴────────┴────────┘

Req/Bytes counts sampled once per second.
# of samples: 10

63k requests in 10.01s, 7.92 MB read

So we improved the performance of probot by 10x!

Good job!

[gr2m]

Yoooooooooooo!

[AaronDewes]

So we improved the performance of probot by 10x!

You seem to be benchmarking / in both versions. I think you should rather benchmark / for v12 and /api/github/webhooks for v13, otherwise, you're not triggering the code.

[AaronDewes]

Oh, you've owerwritten WEBHOOK_PATH, ignore my Last comment then.

[github-actions]

🎉 This PR is included in version 13.0.0-beta.11 🎉

The release is available on:

• GitHub release
• npm package (@beta dist-tag)

Your semantic-release bot 📦🚀