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

未关闭
#14,224 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
go
领域
observability

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Java
星标
25k
派生
6.6k
平均合并
12 小时 1 分钟
30 天内合并 PR
43

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/skywalking 的其他 Issue

查看 apache/skywalking 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。