Repository navigation
docs: define ASAPQuery compatibility profile - #479
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
ASAPQuery-backend currently documents its broader distributed Collector and modified-OTLP architecture. ProjectASAP/ASAPQuery has a smaller drop-in scope: Prometheus copies raw samples through Remote Write, the query engine builds summaries locally, and unsupported queries fall back to Prometheus.
We need an explicit compatibility target before reintroducing that path so it does not accidentally restore stale planner code or couple the MVP to ASAPCollector.
Before this PR
The active architecture said Prometheus Remote Write and backend-local raw precompute were not the MVP architecture. There was no current contract for running ASAPQuery-backend without ASAPCollector or for treating the ASAPQuery scope as a subset of the larger backend.
After this PR
A backend-specific
asapquerycompatibility profile defines:The profile:
The existing getting-started pages now identify themselves as the distributed Collector profile and link to this smaller alternative.
Reference behavior is pinned to ProjectASAP/ASAPQuery commit
9fb051aa798361fca8e3012835412cb6fa338a0c. Canonical logical planning remains owned by the pinned ASAPPlanner; this proposal does not copy the historical ASAPQuery planner.Validation
git diff --cached --checkScope
Documentation only. Runtime implementation is intentionally split into the phases described by the new contract.