From 509773862ebcc0dbffea6d30764630263cfa237e Mon Sep 17 00:00:00 2001 From: Jose Quintana <1700322+joseluisq@users.noreply.github.com> Date: Thu, 27 Oct 2022 22:59:11 +0200 Subject: [PATCH] docs: clarify benchmark context and remarks (#157) resolves #156 --- benchmark/BENCHMARKS.md | 15 ++++++++++++--- benchmark/sws_benchmarks.png | Bin 26580 -> 27125 bytes 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/benchmark/BENCHMARKS.md b/benchmark/BENCHMARKS.md index a276d3b..42d5cb6 100644 --- a/benchmark/BENCHMARKS.md +++ b/benchmark/BENCHMARKS.md @@ -8,7 +8,12 @@ We wanted to prepare some benchmarks to have a general idea about the SWS performance path over time as well as an excuse to improve/optimize SWS in that regard. -**Disclaimer:** Note that this is a rough reference about some particular performance aspects (requests per second and latency on average) so take them at your own risk. +## Important Remarks + +- Note that this is a rough reference about some particular performance aspects (requests per second and latency on average) so take it *at your own risk*. +- Be also aware that **_this benchmark disables in-memory cache_** for some servers intentionally since SWS doesn't provide such a feature yet.
+In the case of some web servers providing that by default then it gets disabled explicitly. See for example [*binserve's author comment*](https://github.com/static-web-server/static-web-server/issues/156#issuecomment-1293941692) in this context. +- Have also in mind that some web servers follow approaches like [Nignx's hybrid disk‑and‑memory cache strategy](https://www.nginx.com/blog/cache-placement-strategies-nginx-plus#Where-is-Cached-Data-Stored) which could work in its favor. ## Web servers setup @@ -16,8 +21,8 @@ We wanted to prepare some benchmarks to have a general idea about the SWS perfor - **nginx** `1.22.0` (default config + worker_processes=4, access_log=off) - **sws** `2.13.1` (default config) - **apache** `2.4.54` (default config) -- **caddy** `2.6.1` (default config) -- **binserve** `0.2.0` (default config + fast_mem_cache=false, enable_hot_reload=false, enable_logging=false, enable_directory_listing=false) +- **caddy** `2.6.1` (default config) +- **binserve** `0.2.0` (default config + **fast_mem_cache=false**, enable_hot_reload=false, enable_logging=false, enable_directory_listing=false) ## How to measure @@ -40,3 +45,7 @@ The data used can be found in [sws_benchmarks.csv](sws_benchmarks.csv). - **Kernel:** 5.19.13-arch1-1 (64 bits) - **Processor:** 4 × Intel® Core™ i7-6500U - **RAM:** 8 GiB + +## Contributions + +Of course, if you find any issue or remark/improvement to do please don't hesitate to file an [issue](https://github.com/static-web-server/static-web-server/issues) or send a [Pull request](https://github.com/static-web-server/static-web-server/pulls). diff --git a/benchmark/sws_benchmarks.png b/benchmark/sws_benchmarks.png index fc9a6c4..3af190d 100644 Binary files a/benchmark/sws_benchmarks.png and b/benchmark/sws_benchmarks.png differ -- libgit2 1.7.2