Skip to content

Neutral READMEs: every library linked, workloads explained, varmq v1.10.0 - #5

Merged
fahimfaisaal merged 2 commits into
mainfrom
docs/neutral-readmes
Oct 25, 2026
Merged

fahimfaisaal merged 2 commits into
mainfrom
docs/neutral-readmes

Conversation

@fahimfaisaal

Copy link
Copy Markdown
Member

What

  • Root README: no Results section and no VarMQ framing; the repo reads as benchmarks for several Go libraries. Suites table, environment, a versions table with every library and client linked, how to run.
  • Every README: each library linked to its repository on first mention and in every table; prose lists libraries alphabetically; findings are rankings.
  • varmq v1.10.0: the three go.mod files require v1.10.0 and keep building the unreleased local checkout through replace until the tag exists. Docs say v1.10.0; the root Running section says how the build finds it.
  • Workloads explained: pool (producers, tasks, timed region, submit and teardown per subject), redis (new Workloads section; C1/C4 are library instances in one process, not separate processes; enqueue-to-handler latency), sqlite (per-queue counts, payloads, file layout, priority mapping, walMB, failure list).
  • Dashboard text: the redis and sqlite dataset descriptions list libraries alphabetically and say "library instances".
  • Known harness gaps, stated where they apply: empty Loop task body, teardowns that don't wait for workers (Ants, Gopool, VarMQ), redis duplicates not failing a row, sqlite exactly-once checked by total. A follow-up PR fixes them and reruns the suites.

No benchmark data changes in this PR.

Verified

  • go list -m github.com/goptics/varmq → v1.10.0 => ../../varmq and go vet clean in all three modules.
  • No "unreleased", "415ad73", "consumer process" or "pickup latency" left in the READMEs; every library named in a README is linked.
  • Every number in the suite READMEs was recomputed from bench/*.txt by a reviewer.
  • task site:json: 495 ×3, 135, 32 rows; new descriptions in the dataset JSON.

🤖 Generated with Claude Code

fahimfaisaal and others added 2 commits October 25, 2026 09:34
The three go.mod files require varmq v1.10.0 and keep building the
unreleased local checkout through the replace directive until the tag
exists. The redis and sqlite dataset descriptions list the libraries
alphabetically and call C1/C4 library instances in one process, which
is what the harness runs. pool:bench gets -timeout 0 like the full run.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Root README: no results, no VarMQ framing; suites, environment, a
  linked versions table and how to run.
- Every library and client is linked to its repository; varmq is
  labelled v1.10.0 (built from the local checkout until it is tagged).
- pool: what a producer is, what each task does, what is timed, how each
  subject submits and tears down.
- redis: a Workloads section: what one op does, the payload, producers,
  W and C (library instances in one process, not processes), the
  enqueue-only and enqueue-to-handler latency runs, and what fails a row.
- sqlite: per-queue job counts, stored payloads, file layout, priority
  mapping, what drain timing includes, walMB, the full failure list.
- Known harness gaps are stated where they apply.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@fahimfaisaal
fahimfaisaal merged commit 9c91781 into main Oct 25, 2026
1 check passed
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