mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-07-03 22:51:58 +00:00
docs(chunked_load): document RunStartupLoad orchestrator in package doc
Round-1 fix (C1): the package-level doc enumerated LoadChunked, loadStatusMiddleware, and OnChunkLoaded but never mentioned RunStartupLoad — the orchestrator that gates the bg loader on LoadChunked completion (#1809). Add it so future readers can find the entry point without grepping main.go. Pure doc change. Refs #1809, PR #1811.
This commit is contained in:
@@ -8,6 +8,12 @@ package main
|
||||
// first chunk is merged into the store, FirstChunkReady is closed.
|
||||
// main.go binds the HTTP listener on that signal and serves
|
||||
// partial data while remaining chunks stream in the background.
|
||||
// * RunStartupLoad is the orchestrator: it runs LoadChunked
|
||||
// synchronously, then on success runs loadBackgroundChunks
|
||||
// synchronously so s.oldestLoaded is guaranteed set before the
|
||||
// background loader reads it (#1809). main.go typically invokes
|
||||
// RunStartupLoad inside its own goroutine and waits on
|
||||
// FirstChunkReady() in parallel to bind the HTTP listener.
|
||||
// * loadStatusMiddleware stamps X-CoreScope-Load-Status on every
|
||||
// response: "loading; progress=<rows>" until LoadComplete()
|
||||
// reports true, then "ready". Dashboards and probes can read the
|
||||
|
||||
Reference in New Issue
Block a user