Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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; their current-code
notes and migration gates distinguish implemented behavior from proposed changes.

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.
- [Planner output to backend physical plans](asapplanner-integration.md) defines
how one selected semantic DAG becomes executable PrecomputePlan and QueryPlan
subgraphs joined at materialization boundaries.
- [Summary Catalog and SDS](summary-catalog-sds-architecture.md) owns descriptors,
definition/instance identity, version-scoped state references, readiness and
lifecycle semantics.
- [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 compatibility baseline until coordinated migrations
land. These proposals do not silently change those interfaces. 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