Skip to content

docs(design): reorder buffer metrics and --delay-updates bypass#3703

Merged
oferchen merged 1 commit into
masterfrom
docs/reorderbuffer-metrics-bypass-1885-1886
May 5, 2026
Merged

docs(design): reorder buffer metrics and --delay-updates bypass#3703
oferchen merged 1 commit into
masterfrom
docs/reorderbuffer-metrics-bypass-1885-1886

Conversation

@oferchen
Copy link
Copy Markdown
Owner

@oferchen oferchen commented May 5, 2026

Summary

  • Adds docs/design/reorderbuffer-metrics-and-bypass.md (499 lines) covering tasks Ensure release task uploads cross-compiled binaries #1885 (queue-depth and stall-duration metrics for BoundedReorderBuffer) and Ensure release checksums are verifiable #1886 (skip the buffer when --delay-updates is off).
  • Part A specifies five u64 counters (current/peak depth, total/episode stall, derived mean), the two insert/drain_consecutive instrumentation hooks, single-threaded plain-u64 storage rationale, debug_log!(Pipeline, 2, ...) emission at -vv, and an opt-in --reorder-metrics-json flag.
  • Part B specifies a BypassPipeline sibling to ParallelDeltaPipeline selected from WriteConfig::delay_updates, the correctness argument across NDX ack ordering, on-disk commit ordering, and the --delete-during directory fence (cross-references Ensure packages coexist with upstream rsync #1893), plus an identical-output fixture, unit test, and interop assertion.
  • Recommends metrics-first ordering: bypass lands only after live peak_depth and stall_count data confirm the head-of-line stall is real.

Test plan

  • markdownlint clean on the new doc
  • Doc renders correctly on GitHub (tables, code blocks, internal links)
  • No references to forbidden tooling terms or em-dashes

Designs two complementary improvements to BoundedReorderBuffer (#1885,
#1886): per-buffer queue/peak/stall counters with debug_log + JSON
emission, and a wire-order bypass mode active when --delay-updates is
off. Metrics first to gate the bypass on measured evidence.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 5, 2026
@oferchen oferchen merged commit 6af295c into master May 5, 2026
8 checks passed
@oferchen oferchen deleted the docs/reorderbuffer-metrics-bypass-1885-1886 branch May 6, 2026 18:57
oferchen added a commit that referenced this pull request May 18, 2026
Designs two complementary improvements to BoundedReorderBuffer (#1885,
#1886): per-buffer queue/peak/stall counters with debug_log + JSON
emission, and a wire-order bypass mode active when --delay-updates is
off. Metrics first to gate the bypass on measured evidence.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant