[RCA] Record component versions and incident-local identity mapping

Open
#14,224 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
go
Domain
observability

Research direction

Read prerequisite issue #14223 and inspect the workspace manifest it introduces, then trace the existing FODC identity fields and pkg/version. The proposed entry point is bydbctl rca inventory; its command and package seams are not established yet. Done means the command preserves mixed and unknown versions, records explicit mappings, refuses ambiguous joins and output conflicts, and passes focused TestRCA behavioral tests.

Written by the indexing model from the issue text.

Description

database enhancement

Umbrella: #14222

Blocked by: #14223

Summary

Record component versions and incident-local identity mapping. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: bydbctl rca inventory --workspace … --input inventory.json. Command names are proposed, not existing APIs.
Reporter collection runs with read-only source access; offline steps use local files only.
No source storage/wire-format changes are requested. The incident format is separately versioned.

Requirements

R1. Ingest an explicit reporter-supplied component inventory; record role, original node/pod reference, version, commit and image digest with source and observation time. No Kubernetes credentials or automatic cluster-wide discovery are required for this first slice.
R2. Preserve mixed versions, conflicts and unknown values. Never infer every node version from the collector or a single pod.
R3. Assign stable workspace-local component references; store explicit mappings between observed native-log/FODC identities. Ambiguous mappings remain unresolved; do not silently join equal display names.
R4. Record collector/build/schema versions independently of database versions. Keep raw names and mapping material private for later release transformation.

Acceptance criteria

  • A manually authored inventory contains data nodes on versions A and B, an unknown FODC build, and duplicate pod names in different namespaces. Output preserves both builds and refuses the ambiguous join.
  • Run inventory against the workspace from #14223; verify every declared reference resolves or has an explicit unresolved reason, and inventory ingestion changes no original evidence.
  • Use hand-authored or independently captured fixtures with documented provenance; do not generate expected values using the code under test.
  • Add focused behavioral tests before implementation and record the actual RED command/failure, then GREEN results.
  • Keep existing CLI/API behavior compatible. Never overwrite unrelated user files; output conflicts must be refused.

Scope and readiness audit

  • Boundary and behavior: the single operation above; independently observable output and refusal behavior.
  • Production activation: the named CLI or skill entry point above, included in the same PR.
  • Packages/callers: pkg/version; existing FODC identity fields; workspace manifest introduced by #14223.
  • Dependencies: #14223
  • Classification: planned blocked leaf; revalidate prerequisite seams after merge.
  • RED evidence: not executed during this planning task; no claim of passing or failing implementation tests.
  • End-to-end proof: the real command/skill scenarios above, not source-text assertions.
  • Formats/lifecycle/fixtures: private workspace or public archive only; artifact-specific fixture family above.
  • Focused tests: CLI leaves should add TestRCA… coverage under bydbctl/internal/cmd and/or the introduced collector package;
    run go test ./bydbctl/internal/cmd -run TestRCA -count=1 plus the new package tests. Skill leaves must add a replayable evaluation harness
    with an exact command documented in the PR. Final test names/paths are fixed when the prerequisite seam merges.
  • Resource/concurrency checks: cancellation, bounded reads/output and cleanup on failure; use repository panic-aware goroutine wrappers if concurrency is introduced.
  • Decision: one proposed PR. If the named behavior requires an unimplemented server API or another lifecycle change, stop and split that prerequisite.

Required-only scope audit

Per-component provenance and explicit identity mapping are required; automatic discovery is not.

Removed/deferred: Automatic Kubernetes discovery, image-tag inference, heuristic identity matching and producer-wide naming changes.

Out of scope

Changing every telemetry producer, guessing versions from image tags, Kubernetes discovery, universal naming migration.

Dominant language
Java
Stars
25k
Forks
6.6k
Avg merge
12h 1m
Merged PRs (30d)
43

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/skywalking

All issues in apache/skywalking

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.