mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-08-18 12:08:22 +00:00
8d9f24d1b6
* docs: add entity relationships and graph query RFC Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: revise entity-graph RFC after review - Zero-configuration declarations: the Prometheus-on-Kubernetes convention pack (job/instance per the OTel-Prometheus compatibility spec, k8s SD labels, *_info descriptors, target_info enrichment) alongside the OTLP trace auto-stamp, plus Remote Write 2.0 inline metadata. - Calls endpoints follow the service entity declaration; self-calls compare full endpoint ids; no silent identity fallback. - Strict time-window contract: the source window is never narrower than the query's observed_at range; unsafe-to-extract predicates error instead of silently defaulting. - scope removed from the relationship schema (kept on entities as a display property); entity row contract restated per projected observation; endpoint encoding documented as the v1 storage-level key with its known collision limitation. - Sampling caveats corrected (ratios are representative only under unbiased sampling); snapshot relation synthesizes endpoint-only vertices; shared attributes provide join keys while co-declaration provides relationship semantics. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: align entity-graph RFC contracts and tighten prose - Metric/trace service unification is promised only when service.namespace is empty and job is not relabeled (the compatibility spec renders job as <namespace>/<name>); otherwise alignment needs pipeline normalization or explicit declarations. - Entity row contract stated once (per projected observation); the calls defining SQL is marked as the single-column simplification of the declaration-derived endpoint ids; Remote Write 2.0 metadata intake and the Prometheus implicit declarations are listed as M1 work. - Compress survey/example/reference prose. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: pin down the k8s convention pack rules and edge directions - kube_pod_owner implicitly declares k8s.workload with id (namespace, owner_kind, owner_name) and derives pod part_of workload; target_info's non-job/instance labels are implicit service descriptive columns — fixed rules, no new declaration syntax. - One direction for pod placement: k8s.pod runs_on k8s.node (pod added to runs_on sources; node->pod removed from contains). - Drop the remaining 'canonical' wording for the v1 storage-level id. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: make contains/part_of a true inverse pair part_of covers service.instance->service and k8s.pod->k8s.workload with contains as its inverse; has_instance is dropped. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: rewrite entity-graph RFC as a design narrative Restructure for human review: mainline first, cases illustrate the design instead of specifying it. - New Architecture and Benefits and Drawbacks sections; the calls derivation stays expanded as the flagship example while schema enumerations, window-rule listings, and executor edge-case handling move out of the document. - The cross-signal promise is stated honestly: neighbours and their source tables are discovered first, their telemetry is the next query — one engine, two statements; the worked example shows the full declaration -> entity -> edge -> telemetry flow. - Default materialisation added as the most direct alternative to read-time derivation, with its costs. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: final wording pass on the entity-graph RFC Mark the property-graph DDL as illustrative rather than settled M2 syntax, credit standards as foundations rather than claiming wholesale alignment, and clean up punctuation-heavy prose. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: keep the RFC at design altitude Demote the convention-pack rule details and snapshot property-merge semantics to the implementing changes; correct the single-trace-table assumption (traces can be routed to multiple tables); record attribute-key participation in entity equality as an open question. Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: correct service graph terminology Signed-off-by: Dennis Zhuang <killme2008@gmail.com> --------- Signed-off-by: Dennis Zhuang <killme2008@gmail.com>