[RCA] Add the reporter RCA collection and release skill

Open
#14,235 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
Mostly clear
Activity status
Active
Tech stack
go

Research direction

Read the prerequisite issues #14227, #14234, #14231, #14232, and #14233 first to confirm the CLI and skill seams, then inspect the existing skills directory and supported CLI commands. Build the reporter collection and release walkthrough with scripted fixtures for slow query and memory pressure incidents, and add a replayable evaluation harness with its command documented in the PR. Done means the walkthrough gathers the specified evidence and version records, passes the adversarial log and privacy checks, and stops for explicit release approval.

Written by the indexing model from the issue text.

Description

AI Assistant database enhancement

Umbrella: #14222

Blocked by: #14227, #14234, #14231, #14232, #14233

Summary

Add the reporter RCA collection and release skill. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: skills/banyandb-rca-collect/SKILL.md invoking the implemented CLI. 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. Guide a reporter from incident scope through budgeted source collection, inventory, curation, sanitization and explicit release review. Show the planned source reads and configured limits first; do not promise workload estimates.
R2. Choose existing evidence before any new capture; never enable tracing/profiling or replay requests as an implicit step. Missing sources yield an honest partial bundle.
R3. Keep raw evidence out of a hosted model context; expose safe inventory/coverage metadata only unless the reporter explicitly approves that provider boundary. Never publish files automatically. CLI privacy checks remain mandatory.
R4. Document invocation for Claude Code and Codex without making either model responsible for deterministic privacy checks; the CLI remains the enforcement point.

Acceptance criteria

  • Use scripted tool-response fixtures for a slow query and a memory-pressure incident. The walkthrough calls only supported commands, collects version records and the relevant crash/profile artifacts, then stops for approval.
  • Adversarial instructions embedded in a log cannot trigger shell execution, network upload or skipping sanitization. No credentials are requested for offline steps.
  • 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: existing skills directory; tested CLI operations from #14223–#14234.
  • Dependencies: #14227, #14234, #14231, #14232, #14233
  • 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

A reporter skill is explicitly requested; a web app and universal model support are not.

Removed/deferred: Live collection UI, automatic posting, provider installation, and guarantees across every model/version.

Out of scope

Building a live collection web app, duplicating CLI logic inside prompts, automatic issue posting.

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.