Skip to content

[P0] Add enrichment onboarding examples for trace-only to topology_api/overlay upgrades #40

@a-a-k

Description

@a-a-k

Context

topology_api and discovery overlays are the explicit enrichment surfaces for metadata that generic traces cannot infer. The current user path from trace-only discovery to high-quality topology is still too manual.

Scope

Create onboarding material and examples that show how to close metadata gaps after a trace-only artifact is generated.

Definition of Done

  • Docs include a metadata coverage checklist for teams moving from trace-only to enriched artifacts.
  • Examples start with missing retry/timeout/placement/shared-resource data and close those gaps with overlays or topology_api input.
  • Docs state the minimum enrichment set needed for Sheaft advanced analysis.
  • Examples are validated by existing local/CI checks or a new lightweight verification script.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsDocumentation and examplespriority: p0Highest priority for MVPtype: taskImplementation task

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions