Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
749252d
docs: clarify Planner physical plan and SDS architecture
zzylol Sep 17, 2026
74255ec
docs: specify executable subplan materialization boundaries
zzylol Sep 18, 2026
d048262
docs: scope migration to backend precompute and query plans
zzylol Sep 18, 2026
ae92339
docs: clarify window terminology migration
zzylol Sep 18, 2026
d25d6c9
Revert "docs: clarify window terminology migration"
zzylol Sep 18, 2026
011a6cd
docs: focus physical plan and SDS designs
zzylol Sep 18, 2026
1ca64ed
docs: add physical compiler input example
zzylol Sep 18, 2026
06b26eb
docs: add physical compiler output example
zzylol Sep 18, 2026
9a1c41b
docs: include query expression in compiler example
zzylol Sep 18, 2026
19bc7da
docs: reorganize physical plan integration design
zzylol Sep 18, 2026
8fbe0f3
docs: reorganize SDS and migration designs
zzylol Sep 18, 2026
eb3c3c4
docs: define maintenance inputs before plan split example
zzylol Sep 18, 2026
c9b6ea7
docs: use plan version consistently in backend design
zzylol Sep 18, 2026
4de2df4
docs: remove standalone catalog materialization abstraction
zzylol Sep 18, 2026
9892bed
docs: add concise planner backend glossary
zzylol Sep 18, 2026
1232ce9
docs: clarify selected deployment guarantee terminology
zzylol Sep 21, 2026
158c22a
docs: explain missing planner maintenance guarantee
zzylol Sep 21, 2026
6322175
docs: motivate selected producer maintenance decision
zzylol Sep 21, 2026
8bdb7a7
docs: label catalog reads and SDS metadata ownership
zzylol Sep 21, 2026
813e3e3
docs: align SDS ownership and lifecycle terminology
zzylol Sep 21, 2026
f3bd9d8
docs: use current planner and plan-version names consistently
zzylol Sep 21, 2026
11e21d2
docs: align integration diagram with SDS ownership
zzylol Sep 21, 2026
b4dec9b
docs: clarify instance identity and shared producer wording
zzylol Sep 21, 2026
f300704
docs: distinguish summary definitions from runtime stores
zzylol Sep 22, 2026
520ace6
docs: model one runtime summary store for DAG bindings
zzylol Sep 22, 2026
864c2a2
docs: scope SDS lifecycle to read eligibility
zzylol Sep 22, 2026
e0ab398
docs: tie stored summary examples directly to DAG outputs
zzylol Sep 22, 2026
5f383d1
docs: name summary tables, stored records, and output references by role
zzylol Sep 22, 2026
a2ab168
docs: illustrate summary definitions, stored records, and output refe…
zzylol Sep 22, 2026
d5f5203
docs: limit v1 summary storage to definitions and stored summaries
zzylol Sep 22, 2026
ebf4569
docs: separate Planner physical computation from backend deployment
zzylol Sep 25, 2026
eb60220
docs: bind Planner physical DAGs without backend re-lowering
zzylol Sep 26, 2026
1b36bb7
docs: describe summary inputs with groups and pane duration
zzylol Sep 26, 2026
b12512f
docs: define summary semantic completeness beyond input scope
zzylol Sep 26, 2026
51185de
docs: define SDS identity through canonical Planner computation
zzylol Sep 26, 2026
69b28c2
docs: decouple SDS semantic identity from executable Planner IR
zzylol Sep 26, 2026
5ffc426
docs: define Planner-owned SDS discovery for future ad hoc queries
zzylol Sep 26, 2026
5bcd54c
docs: streamline SDS design around definitions and stored results
zzylol Sep 26, 2026
5b402b8
docs: track bound-query SDS migration across implementation PRs
zzylol Sep 26, 2026
0d9ab8e
docs: identify active shared-library PR in bound-query migration
zzylol Sep 26, 2026
ef6c127
docs: separate bound SDS range lookup from state validation
zzylol Sep 26, 2026
eb94d73
docs: state SDS migration responsibilities without stale implementati…
zzylol Sep 26, 2026
5f1eebf
docs: preserve design index after rebasing onto main
zzylol Sep 28, 2026
8857f25
docs: clarify SDS source identity and version-scoped recovery
zzylol Sep 28, 2026
bccb189
docs: illustrate SDS identity and recovery decisions
zzylol Sep 28, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 25 additions & 21 deletions docs/design_docs/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# System design location
# Design documents

ASAPQuery-backend does not maintain a second copy of the system design.
The canonical component design is in
[ASAPCollector/docs/design_docs](https://github.com/ProjectASAP/ASAPCollector/tree/main/docs/design_docs).
These documents are for architects and developers. The integration proposal and
SDS model below define the target Planner-to-runtime boundary. Acceptance
requirements and migration gates distinguish target behavior from completed
integration.

Backend-specific implementation design notes are organized by component under
[`../developer_docs`](../developer_docs/README.md). They explain current Rust
internals and are subordinate to the shared system contracts.
- [Planner/backend glossary](planner-backend-glossary.md) defines the terms used
by the following three designs.
- [Binding Planner Physical DAGs to deployment plans](asapplanner-integration.md)
defines how backend source/state bindings and operational policy instantiate
Planner-provided maintenance and query computation.
- [Summary definitions table and SDS](summary-catalog-sds-architecture.md) owns definition
and instance identity, version-scoped state references, read eligibility and
committed-state metadata.
- [Architecture migration delivery plan](asapplanner-migration-plan.md) defines
common-library extraction, removal of ASAPCollector dependencies, the two-plan
rollout, and backend acceptance/retirement gates.
- [Accepted-input completeness](continuous-summary-completeness.md) describes
the backend's bounded admission, publication and recovery behavior.

Proposals for shared-contract review:
Existing [Collector system contracts](https://github.com/ProjectASAP/ASAPCollector/tree/main/docs/design_docs)
remain the cross-component baseline. Current backend implementation guides live
under [developer docs](../developer_docs/README.md).

- [ASAPPlanner integration architecture](asapplanner-integration.md) proposes
the Planner/backend responsibility boundary, shared semantic DAG workflow,
and high-level consolidation milestones.
- [Summary Catalog and SDS Architecture](summary-catalog-sds-architecture.md) defines the proposed
Summary Descriptor, Data Descriptor and Summary Instance layers.
Other designs and profiles:

These proposals complement the canonical cross-component contracts above.

Backend-specific operating profiles:

- [ASAPQuery compatibility profile](asapquery-compatibility-profile.md) defines
the smaller target configuration for Prometheus Remote Write, backend-local
precompute, and PromQL serving without ASAPCollector. It becomes a strict
configuration subset after its currently missing Remote Write adapter lands.
- [ASAPQuery compatibility profile](asapquery-compatibility-profile.md)
- [Shape-aware ERP](shape-aware-erp-v1.md)
- [Empirical observability execution plan](empirical-o11y-execution-plan.md)
Loading
Loading