Skip to content

bench: methodology doc + results snapshot template#124

Merged
eschizoid merged 1 commit into
bench/latency-percentilesfrom
bench/methodology-and-results
May 16, 2026
Merged

bench: methodology doc + results snapshot template#124
eschizoid merged 1 commit into
bench/latency-percentilesfrom
bench/methodology-and-results

Conversation

@eschizoid

Copy link
Copy Markdown
Owner

Stacked on top of #123.

  • `benchmarks/METHODOLOGY.md` — what each bench measures, how the four parallel runtimes are configured (KPipe / Confluent PC / Reactor / raw), JMH defaults + recommended-publishing config, what to record with every run, caveats around the in-process broker.
  • `benchmarks/results/TEMPLATE.md` — the format for dated benchmark snapshots. Environment + JMH config + throughput / latency / allocation tables. Drop new files in `results/` whenever a runtime version bumps or the suite changes.
  • `benchmarks/README.md` — lede now cross-links to both.

A bench number without context is unverifiable. Adds METHODOLOGY.md documenting what each
bench measures, how the four parallel runtimes are configured, the JMH default + recommended-
publishing configs, what to write down with every published number, and known caveats
(in-process broker, single-broker, single payload size).

Adds results/TEMPLATE.md as the format for dated snapshots — environment, JMH config, scope,
throughput / latency / allocation tables, and a "pitfalls in this run" footer.

Updates benchmarks/README.md lede with cross-links to both.
@eschizoid eschizoid merged commit f7256b6 into bench/latency-percentiles May 16, 2026
2 checks passed
@codecov

codecov Bot commented May 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.68%. Comparing base (4f78ffc) to head (8e5ed1b).
⚠️ Report is 1 commits behind head on bench/latency-percentiles.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@                       Coverage Diff                       @@
##             bench/latency-percentiles     #124      +/-   ##
===============================================================
+ Coverage                        70.48%   70.68%   +0.19%     
- Complexity                         621      623       +2     
===============================================================
  Files                               68       68              
  Lines                             2521     2521              
  Branches                           323      323              
===============================================================
+ Hits                              1777     1782       +5     
+ Misses                             578      575       -3     
+ Partials                           166      164       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

eschizoid added a commit that referenced this pull request May 16, 2026
…gLatencyBenchmark (#129)

GitHub recorded #123 and #124 as merged, but the merge commits ended up on the bench/*
intermediate branches rather than on main — same "merged into the wrong branch" pattern
that's bitten this repo before. The three files below were on those branches but never
landed on main.

This commit copies them straight from origin/bench/methodology-and-results onto a fresh
branch off current main. No edits, no rebase — these files compile cleanly against current
main as-is.

  * benchmarks/METHODOLOGY.md — what each bench measures, how the four runtimes are
    configured, recommended publishing run, caveats around the in-process broker.
  * benchmarks/results/TEMPLATE.md — format for dated snapshots (environment, JMH config,
    throughput / latency / allocation tables).
  * benchmarks/src/.../ParallelProcessingLatencyBenchmark.java — latency-mode companion
    using Mode.SampleTime + Mode.AverageTime for p50/p95/p99/p999/p100 distributions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant