Skip to content

docs(examples): rebuild quickstart-multidomain README as a smart data-retrieval walkthrough#52

Open
qiansheng91 wants to merge 1 commit into
mainfrom
codex/demo-quickstart-readdata
Open

docs(examples): rebuild quickstart-multidomain README as a smart data-retrieval walkthrough#52
qiansheng91 wants to merge 1 commit into
mainfrom
codex/demo-quickstart-readdata

Conversation

@qiansheng91

Copy link
Copy Markdown
Collaborator

What

Turns the default make quickstart pack's README (en + zh) from a terse reference into a guided
smart data-retrieval (智能读数) walkthrough — the read-side companion to the
incident-investigation RCA demo. It pairs with the umodel-query skill.

The walkthrough (7 steps, all verified against live make quickstart data)

  1. Discover the model.umodel → 5 domains / 35 object types.
  2. Read objects.entity → checkout-service (degraded), catalog-api, delivery-service, telemetry-collector.
  3. Search — full-text query='checkout'; mode='vector' / 'hyper' for semantic ranking.
  4. Traverse topology.topo getNeighborNodes … | where __relation_type__='runs' → the cross-domain devops→k8s edge (uses where; a with(...) clause does not filter graph-call output).
  5. Discover capabilities__list_method__ (4 methods) + list_data_set → 3 datasets across Prometheus / Elasticsearch / MySQL.
  6. Read metrics → plan → runprometheus_promql, sum(rate(devops_service_request_total{service_id="…"}[1m])).
  7. Read logs → plan → runelasticsearch_dsl, index devops-service-logs-*.

Real ids/values/plans throughout; links to the umodel-query / umodel-rca skills. The MySQL
event_set is noted as modeled/discoverable (the plan-returning fetch methods today are
get_metrics / get_logs).

Scope

README only (en + zh). Pack model/sample-data unchanged — counts (35 entity sets, 93 entities,
125 relations) and structure were already correct, so make example-validate is unaffected.

…-retrieval walkthrough

Turn the default `make quickstart` pack's README (en + zh) from a terse reference into a guided
"smart data-retrieval" demo aligned with the umodel-query skill — a 7-step walkthrough verified
against live data:

- discover the model (.umodel → 5 domains / 35 object types)
- read objects (.entity → checkout-service degraded, …) and search (full-text + mode=vector/hyper)
- traverse topology incl. the cross-domain devops→k8s `runs` edge (where-filter, not with)
- discover an object's methods + its 3 datasets across Prometheus / Elasticsearch / MySQL
- read metrics → prometheus_promql plan, logs → elasticsearch_dsl plan, then run them

Real ids/values/plans throughout; links to the umodel-query / umodel-rca skills. Pack data
unchanged (model and counts already correct); README only.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant