docs: document sensor-to-central message flow#19403
Conversation
Diagram made by @guzalv, text written by Claude after several "deep dive" sessions looking into the architecture with the author. Co-authored-by: Claude <claude@anthropic.com>
|
Skipping CI for Draft Pull Request. |
|
Images are ready for the commit at 9322231. To use with deploy scripts, first |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #19403 +/- ##
=======================================
Coverage 49.68% 49.69%
=======================================
Files 2700 2700
Lines 203278 203297 +19
=======================================
+ Hits 100999 101022 +23
+ Misses 94753 94750 -3
+ Partials 7526 7525 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
All DedupingQueue instances at every layer have no capacity cap. If a producer outpaces its consumer goroutine, memory grows without limit. Added a Gotcha in Layer 2 (where DedupingQueues are first introduced) covering all layers at once. Partially generated by AI (Claude Opus 4.6).
Items move through Layers 2 and 3 by dispatching only (no heavy work). They actually accumulate in Layer 4 while waiting for pipeline fragments to process them (DB writes etc.). That is the realistic backlog point. Partially generated by AI (Claude Opus 4.6).
janisz
left a comment
There was a problem hiding this comment.
I thought about having this diagram in ASCII but there's no easy way to get it
excalidraw/excalidraw#923
Description
This PR adds a markdown file explaining the architecture of the parts of Central involved in processing messages from Sensor.
This became relevant while investigating out-of-memory crashes, and is the product of the author's research and conversations with AI agents.
The diagram was drawn by the author, and the text was written by Claude based on notes about this topic and the source code. Afterwards another Claude model was instructed to thoroughly review the document and check each claim against the source code.
What follows is mostly written by AI.
Description (AI)
Add a README documenting the sensor-to-central message flow architecture in
central/sensor/service/connection/. The document covers:workerQueues → sharded DedupingQueues → pipeline fragments)
Also adds a pointer to the README from
AGENTS.md.The document was written by Claude (AI) with several deep-dive research sessions into the
codebase, reviewed for correctness against the actual source, and corrected where the
initial version had inaccuracies.
User-facing documentation
Testing and quality
Automated testing
Documentation-only change. No automated tests needed.
How I validated my change
Every claim in the README was verified against the source code.