Skip to content

SlowShield 0.0.4

Choose a tag to compare

@github-actions github-actions released this 04 Oct 18:22
· 36 commits to main since this release
b480db5

Added

  • The Setup page follows slowshield.org: one global shell setup (bash on Linux, bash on macOS, zsh, fish) filled in
    with this instance's URLs and preselected from the visitor's OS, a one-line install to try it, a tool finder (type
    poe for Poetry, ya for Yarn) for pip, uv, Poetry, PDM, Pipenv, npm, pnpm, Yarn and Bun, and CI/Dockerfile
    snippets. Its shell and install snippets come from the same file as the website's
    (src/slowshield/ui/snippets.toml), and an end-to-end test runs every one of them in bash, zsh and fish against
    the stack, including Debian 12's pip 23.0.1.

Changed

  • One host, one path per ecosystem (docs/design/routing.md). The UI lives entirely
    under /ui/: the dashboard moved from / to /ui/ (/ redirects there) and assets from /static/ to
    /ui/static/. The root paths SlowShield answers on are a fixed list, with names reserved for every ecosystem
    on the roadmap.
  • The Setup page shows path URLs only (/pypi/simple/, /npm/).

Deprecated

  • Per-ecosystem hostnames (upstreams.pypi.hostnames / SLOWSHIELD_PYPI_HOSTNAMES, upstreams.npm.hostnames /
    SLOWSHIELD_NPM_HOSTNAMES, Helm ecosystems.*.hostnames), the root PyPI alias (/simple/, /packages/) and
    /static/. They keep working until 0.1, log a startup warning (hostnames), show a notice on the Setup page,
    and are counted in slowshield_legacy_routing_requests_total so operators can see when nothing uses them.

Security

  • Values shown in copy-paste shell snippets can no longer carry shell syntax (reported by Aikido). With
    local_http on, a loopback Host header such as localhost:$(id) was echoed into the Setup page and npm
    tarball links; only well-formed hosts with a numeric port qualify now. public_url and
    upstreams.npm.public_url must be plain http(s)://host[:port][/path] URLs (no query, credentials or
    special characters), and the snippet renderer refuses anything else. A config with such a URL now fails to
    load instead of being served.

Fixed

  • The UI's CSS and JavaScript URLs are versioned by content instead of the release, so an image rebuilt under the
    same version no longer leaves browsers on stale assets.
  • With npm hostnames configured, clients using /npm/ got tarball links on the npm hostname, which then ended
    up in their lockfiles. Tarball links now follow the route the client used.

Images

  • ghcr.io/squirro/slowshield:0.0.4
  • ghcr.io/squirro/slowshield-caddy:0.0.4
Performance (amd64)

SlowShield performance report

Host: Linux/x86_64, 4 CPUs · candidate ghcr.io/squirro/slowshield@sha256:aa16651770ecfb35cc2143f1ed9926c3d35c17b65d8722573d1c50ce2d510cb8 · baseline ghcr.io/squirro/slowshield:latest

Scenario Metric Baseline Candidate Change Limit p
artifact_big:throughput rps 691 678 -2.0% 15% 0.690 ✅
artifact_cached:latency p95_ms 0.70 0.71 +1.3% 15% 0.016 ✅
artifact_cached:latency p99_ms 0.84 0.86 +3.3% 20% 0.421 ✅
artifact_cached:throughput rps 2547 2540 -0.3% 10% 0.690 ✅
blocked:latency p95_ms 0.57 0.58 +0.1% 15% 1.000 ✅
blocked:latency p99_ms 0.77 0.75 -3.3% 20% 0.690 ✅
dashboard:latency p95_ms 2.36 2.38 +1.0% 15% 0.151 ✅
dashboard:latency p99_ms 3.02 2.98 -1.3% 30% 0.421 ✅
mixed:throughput rps 3845 3827 -0.5% 10% 0.841 ✅
npm_huge_corgi:throughput rps 551 560 +1.6% 10% 0.151 ✅
npm_huge_full:throughput rps 432 441 +2.0% 10% 0.421 ✅
npm_packument_corgi:throughput rps 5164 5136 -0.5% 10% 0.310 ✅
npm_packument_full:latency p95_ms 0.45 0.45 -0.4% 15% 1.000 ✅
npm_packument_full:latency p99_ms 0.61 0.63 +2.5% 20% 0.690 ✅
pypi_simple_html:latency p95_ms 1.32 1.80 +35.7% 15% 0.151 ✅
pypi_simple_html:latency p99_ms 1.95 2.29 +17.4% 20% 0.151 ✅
pypi_simple_json:latency p95_ms 1.90 2.07 +8.9% 15% 0.548 ✅
pypi_simple_json:latency p99_ms 2.68 4.05 +51.0% 20% 0.222 ✅
pypi_simple_json:throughput rps 1023 964 -5.8% 10% 0.690 ✅
process rss_peak_bytes 168.1 MB 171.1 MB +1.8% 15% 0.151 ✅
process startup_s 0.56 0.56 +0.5% 30% 0.222 ✅
image size_bytes 124.0 MB 124.1 MB +0.0% 5% — ✅

Candidate medians

Scenario rps p50 ms p95 ms p99 ms MB/s CPU ms/1k
artifact_big:throughput 678 0.80 0.80 0.80 2.2 1684.0
artifact_cached:latency 300 0.65 0.71 0.86 0.5 499.1
artifact_cached:throughput 2540 12.22 17.99 23.76 4.0 393.5
blocked:latency 300 0.49 0.58 0.75 0.2 337.7
dashboard:latency 30 1.76 2.38 2.98 0.4 1782.7
mixed:throughput 3827 6.74 16.85 21.24 9.1 259.4
npm_huge_corgi:throughput 560 13.65 21.62 25.58 1237.9 1777.0
npm_huge_full:throughput 441 17.92 26.54 30.48 1456.3 2265.9
npm_packument_corgi:throughput 5136 5.68 10.57 16.63 7.9 189.9
npm_packument_full:latency 300 0.37 0.45 0.63 0.7 248.6
pypi_simple_html:latency 300 1.09 1.80 2.29 110.4 867.2
pypi_simple_json:latency 300 1.13 2.07 4.05 138.1 975.7
pypi_simple_json:throughput 964 31.25 49.45 59.47 443.9 1036.2

Image size: 124.1 MB (uncompressed), RSS peak median 171.1 MB

Performance (arm64)

SlowShield performance report

Host: Linux/aarch64, 4 CPUs · candidate ghcr.io/squirro/slowshield@sha256:1633ac14fe1e7b7e350bf1ccdaae48e5beb4f56a83a19f4c32b672beaaace186 · baseline ghcr.io/squirro/slowshield:latest

Scenario Metric Baseline Candidate Change Limit p
artifact_big:throughput rps 403 461 +14.4% 15% 0.310 ✅
artifact_cached:latency p95_ms 0.73 0.70 -4.7% 15% 1.000 ✅
artifact_cached:latency p99_ms 0.84 0.84 -0.8% 20% 1.000 ✅
artifact_cached:throughput rps 3071 3158 +2.8% 10% 0.421 ✅
blocked:latency p95_ms 0.60 0.57 -4.4% 15% 0.310 ✅
blocked:latency p99_ms 0.77 0.76 -1.8% 20% 0.548 ✅
dashboard:latency p95_ms 3.24 3.08 -4.8% 15% 0.222 ✅
dashboard:latency p99_ms 3.67 3.43 -6.4% 30% 0.310 ✅
mixed:throughput rps 4831 4921 +1.9% 10% 0.222 ✅
npm_huge_corgi:throughput rps 696 826 +18.7% 10% 0.548 ✅
npm_huge_full:throughput rps 560 575 +2.5% 10% 0.690 ✅
npm_packument_corgi:throughput rps 7348 7520 +2.3% 10% 0.222 ✅
npm_packument_full:latency p95_ms 0.42 0.41 -3.6% 15% 0.548 ✅
npm_packument_full:latency p99_ms 0.59 0.56 -6.0% 20% 0.548 ✅
pypi_simple_html:latency p95_ms 1.31 1.22 -7.2% 15% 0.690 ✅
pypi_simple_html:latency p99_ms 1.88 1.77 -5.9% 20% 0.841 ✅
pypi_simple_json:latency p95_ms 1.67 1.68 +0.6% 15% 0.690 ✅
pypi_simple_json:latency p99_ms 2.44 2.04 -16.1% 20% 1.000 ✅
pypi_simple_json:throughput rps 1396 1545 +10.7% 10% 1.000 ✅
process rss_peak_bytes 152.7 MB 154.9 MB +1.5% 15% 1.000 ✅
process startup_s 0.53 0.52 -1.9% 30% 0.548 ✅
image size_bytes 115.8 MB 115.9 MB +0.0% 5% — ✅

Candidate medians

Scenario rps p50 ms p95 ms p99 ms MB/s CPU ms/1k
artifact_big:throughput 461 1.00 1.00 1.00 1.5 980.0
artifact_cached:latency 300 0.65 0.70 0.84 0.5 565.5
artifact_cached:throughput 3158 9.92 14.52 18.72 4.9 316.5
blocked:latency 300 0.51 0.57 0.76 0.2 360.0
dashboard:latency 30 2.30 3.08 3.43 0.4 2251.9
mixed:throughput 4921 5.62 13.22 15.89 11.7 203.0
npm_huge_corgi:throughput 826 9.33 14.08 16.89 1827.1 1209.1
npm_huge_full:throughput 575 13.87 19.09 21.70 1898.2 1739.5
npm_packument_corgi:throughput 7520 3.81 7.37 11.23 11.5 131.0
npm_packument_full:latency 300 0.35 0.41 0.56 0.7 269.1
pypi_simple_html:latency 300 0.97 1.22 1.77 110.4 835.6
pypi_simple_json:latency 300 1.01 1.68 2.04 138.2 902.3
pypi_simple_json:throughput 1545 19.75 30.40 37.09 711.4 646.7

Image size: 115.9 MB (uncompressed), RSS peak median 154.9 MB