Document benchmark limitations and fix CI timeout issues#76
Merged
Conversation
…sis findings Address all findings from the 237-benchmark criterion analysis: Timeout fixes (10 warnings → 0): - transport/payload_scaling: 8s → 10s (4KB/16KB needed 8.4–9.5s) - concurrent/sends: 18s → 30s (/16 needed 28.8s at 5.68ms × 5050 iters) - realistic/payload_complexity: 10s → 15s (mixed_parts marginally over) - realistic/connection: 10s → 15s (new_client_per_request TCP setup) - enterprise/client_interceptors: 8s → 10s (/5 and /10 chains over) Benchmark fixes: - dispatch_routing: pre-allocate params outside measurement loop for fair comparison between direct handler invoke and HTTP round-trip - data_volume/save: document wide CIs from BTreeSet rebalancing spikes Documentation (8 new Known Measurement Limitations): - data_volume/save wide confidence intervals - dispatch routing direct vs HTTP (near-parity validates keep-alive) - cold start vs steady state (complementary, not comparable) - subscribe fan-out O(1) scaling up to 5 subscribers - agent burst sub-linear scaling (714→310µs/agent) - tenant resolver negligible overhead (88–173ns) - pagination context index 2× speedup - Updated generate_book_page.sh footer, benches/README.md, CHANGELOG.md, root README.md, CI/CD book page, testing book page, workflows README https://claude.ai/code/session_01YNLEZUUKzzs4qjkj1TPgXz
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation for known benchmark measurement limitations and resolves Criterion.rs timeout warnings by increasing measurement time budgets for 5 benchmark groups that were marginally exceeding their time limits on CI runners.
Key Changes
Documentation Improvements:
benches/README.mdand auto-generated benchmark results page covering:book/src/deployment/testing.mddocumenting all 13 suites and 237 benchmarksbook/src/deployment/cicd.mddescribing the benchmarks workflowBenchmark Timeout Fixes:
transport/payload_scaling: 8s → 10s (4KB and 16KB payloads needed 8.4–9.5s)concurrent/sends: 18s → 30s (4-concurrent and 16-concurrent cases needed 21.8–28.8s)realistic/payload_complexity: 10s → 15s (mixed_parts and nested_metadata exceeded budget)realistic/connection: 10s → 15s (new_client_per_request TCP setup cost)enterprise/client_interceptors: 8s → 10s (5 and 10 interceptor chains exceeded budget)Benchmark Code Improvements:
production_scenarios.rs: Pre-allocatedirect_paramsoutside the measurement loop inbench_dispatch_routingto isolate handler dispatch cost from fixture allocation, producing fairer comparison against HTTP round-trip pathdata_volume.rsexplaining BTreeSet rebalancing variance in theafter_prefill/10000caseDocumentation Updates:
.github/workflows/README.mdto document the benchmarks workflowNotable Details
https://claude.ai/code/session_01YNLEZUUKzzs4qjkj1TPgXz