docs(inkless): fix performance docs#482
Conversation
e57397b to
fcf81a5
Compare
fcf81a5 to
11df5ae
Compare
There was a problem hiding this comment.
Pull request overview
This pull request improves the Inkless performance documentation by fixing a broken link in the FAQ and adding comprehensive content about consumer-side caching and performance optimization. The changes provide detailed explanations of how Inkless's caching architecture works with AZ-aware partition assignment, the hot/cold path separation for handling recent vs. lagging consumer requests, and practical tuning guidance.
Changes:
- Fixed markdown link syntax in FAQ.md for the performance tuning guide reference
- Added detailed sections on consumer caching architecture, AZ-awareness, and cache efficiency
- Documented hot/cold path separation for managing recent data vs. lagging consumer requests
- Provided comprehensive tuning guidance for both broker and consumer configurations
- Added monitoring metrics documentation and performance optimization recommendations
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/inkless/FAQ.md | Fixed broken link to PERFORMANCE.md by correcting markdown syntax from parentheses to square brackets |
| docs/inkless/PERFORMANCE.md | Added extensive documentation (169 lines) covering consumer performance, caching behavior, AZ-awareness, hot/cold path architecture, tuning configurations, monitoring metrics, and performance optimization strategies |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/inkless/PERFORMANCE.md
Outdated
| Where `<rack>` matches the `broker.rack` configuration. This ensures: | ||
| - Consumers fetch from deterministically-assigned brokers in the same availability zone | ||
| - Cache hits are served from the broker's local cache (same broker handles same partition) | ||
| - Cross-AZ data transfer costs are minimized |
There was a problem hiding this comment.
In this specific case cross-AZ data transfer are effectively 0
There was a problem hiding this comment.
Good catch. Will clarify this in a fixup commit. PTAL
giuseppelillo
left a comment
There was a problem hiding this comment.
LGTM with a comment.
Will add some docs about the batch coordinate cache in another pr.
* docs(inkless): fix performance docs * fixup! docs(inkless): fix performance docs * fixup! docs(inkless): fix performance docs
* docs(inkless): fix performance docs * fixup! docs(inkless): fix performance docs * fixup! docs(inkless): fix performance docs
Fix links from FAQ, and adds more detail on how consumer-side and caching performance implications work.