Skip to content

Conversation

@jeqo
Copy link
Contributor

@jeqo jeqo commented Jan 16, 2026

Fix links from FAQ, and adds more detail on how consumer-side and caching performance implications work.

Base automatically changed from jeqo/docs-az-alignment to main January 19, 2026 10:03
@jeqo jeqo force-pushed the jeqo/docs-fix-perf branch from e57397b to fcf81a5 Compare January 19, 2026 10:49
@jeqo jeqo force-pushed the jeqo/docs-fix-perf branch from fcf81a5 to 11df5ae Compare January 19, 2026 10:52
@jeqo jeqo marked this pull request as ready for review January 19, 2026 10:53
@jeqo jeqo requested a review from Copilot January 19, 2026 10:58
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this specific case cross-AZ data transfer are effectively 0

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Will clarify this in a fixup commit. PTAL

giuseppelillo
giuseppelillo previously approved these changes Jan 19, 2026
Copy link
Contributor

@giuseppelillo giuseppelillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a comment.
Will add some docs about the batch coordinate cache in another pr.

@giuseppelillo giuseppelillo merged commit 621a517 into main Jan 20, 2026
6 checks passed
@giuseppelillo giuseppelillo deleted the jeqo/docs-fix-perf branch January 20, 2026 09:20
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.

3 participants