[RCA] Create a reviewable evidence-selection plan

Open
#14,229 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
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go, java
Domain
cli, observability

Research direction

Start by checking the prerequisite issue #14223 and the existing bydbctl command structure under bydbctl/internal/cmd; the issue says the final test paths depend on the prerequisite seam. Implement and test the proposed selection operation through its real CLI entry point, covering budget refusal, pinned evidence, exact ledger reasons, coverage, unchanged raw hashes, and output conflicts. Done means the acceptance scenarios pass with focused behavioral tests and documented fixture provenance.

Written by the indexing model from the issue text.

Description

database enhancement

Umbrella: #14222

Blocked by: #14223

Summary

Create a reviewable evidence-selection plan. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: bydbctl rca curate --workspace … --selection …. 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. Generate a candidate selection by incident interval, components, sources and byte budget; never mutate raw evidence or claim the selection is public-safe.
R2. Keep a selection ledger naming every included/excluded artifact, reason and coverage consequence. An over-budget selection is refused with the exact excess and an explanation; it is never silently reduced.
R3. Apply explicit reporter inclusion/exclusion rules and pins for contradictory evidence and control samples. No automatic relevance ranking. If the resulting selection exceeds the budget, refuse it with the excess and require a revised selection; never silently discard pinned evidence.
R4. Show size and source/time/component coverage before and after selection, including omitted crash/profile artifacts. Persist the approved selection separately from raw data.

Acceptance criteria

  • A fixed inventory contains a small error log, a healthy control log, a contradictory event and a large profile. A budget too small for pinned evidence fails with the exact excess, not silent removal.
  • Re-run with sufficient budget and check the exact selected IDs and ledger reasons; raw hashes remain unchanged.
  • 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: workspace inventory and artifact metadata; local deterministic selection command.
  • 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

Reporter-controlled reduction is required to make large collections reviewable; relevance ranking is not.

Removed/deferred: Automatic relevance scoring, AI-selected publication, automatic incident detection and report dashboards.

Out of scope

LLM judgment as a safety gate, redaction, archive publication, auto-upload.

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.