[RCA] Download FODC memory-pressure profiles into the private workspace

Open
#14,227 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
20/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go, java

Research direction

Start by resolving blocker #14223 and inspecting the pressure profile endpoints and download handler in fodc/proxy/internal/api/server.go, along with the pressure profiler fixtures. Then trace the proposed bydbctl RCA collection entry point and add behavioral tests for bounded streaming, checksums, interruption cleanup, missing artifacts, and output conflicts. Done means the real command collects private artifacts safely and passes the focused tests; the issue says their final paths depend on the prerequisite.

Written by the indexing model from the issue text.

Description

database enhancement profiling

Umbrella: #14222

Blocked by: #14223

Summary

Download FODC memory-pressure profiles into the private workspace. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: bydbctl rca collect --source=fodc-pressure. 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. List relevant pressure events, then download heap/goroutine artifacts using existing profile endpoints; preserve trigger time, threshold/context and agent identity.
R2. Use streaming bounded downloads with per-file and total caps. Partial files must not be accepted as valid profiles or complete evidence.
R3. Record retention eviction, unsupported agent, missing artifact and HTTP errors independently. Repeated collection must not silently replace an earlier artifact with different bytes.
R4. Store raw profiles as private artifacts excluded from public release by default. Collection must never trigger new profiling implicitly.

Acceptance criteria

  • A fixed profile fixture and independent checksum verify byte-for-byte download. A second event disappears between listing and fetching; record it as unavailable.
  • Interrupt a download and exceed its cap: no valid-profile marker is emitted, temporary files are cleaned or explicitly quarantined, and other completed evidence remains usable.
  • 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: fodc/proxy/internal/api/server.go /pressure-profiles and profile download handler; pressure profiler fixtures.
  • 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

Memory-pressure profiles are explicitly requested; new capture and public binary sanitization are not.

Removed/deferred: On-demand profiling, new triggers, automatic resume and public release of raw binary profiles.

Out of scope

New profiling triggers, profile sanitization, core dumps, automatic publication of binary profiles.

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.