[RCA] Import request-based query traces as incident evidence

Open
#14,228 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

Research direction

Read the proposed bydbctl rca import-query-trace entry point, pkg/query/tracer.go, liaison query response fixtures, and the workspace artifact importer; first revalidate those seams after prerequisite #14223 merges. Add focused behavioral tests with independently documented fixtures before implementation, then record the actual RED failure and GREEN results. Done means one documented response format imports offline with provenance and privacy preserved, malformed or oversized input and output conflicts are refused, and the real CLI behavior passes its end-to-end scenarios.

Written by the indexing model from the issue text.

Description

database enhancement query tracing

Umbrella: #14222

Blocked by: #14223

Summary

Import request-based query traces as incident evidence. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: bydbctl rca import-query-trace --file … --workspace …. 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. Import one explicitly documented measure-query response format containing an execution trace. Reject other formats explicitly; preserve operators, durations, node references and any reported truncation. Do not infer completeness from absent truncation metadata.
R2. Require provenance: original incident request, later armed capture, or replay. Record collection time separately from execution time; unknown execution times remain unknown.
R3. Keep query text/parameters and identifiers private; link a trace to logs only with explicit observed identity or a qualified uncertain mapping.
R4. Record that tracing may suppress slow-query logs. Missing slow logs must not be interpreted as no slow query.

Acceptance criteria

  • Hand-authored original and replay responses have identical query text but different times; the output keeps separate provenance and does not merge them.
  • Reject malformed and oversized input, preserve a truncated trace as partial, and demonstrate that import makes zero network calls.
  • 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/query/tracer.go; liaison query response fixtures; workspace artifact importer.
  • 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

Importing available query-execution evidence is required; capturing every format or replaying requests is not.

Removed/deferred: Additional response formats, automatic arming, replay, continuous tracing and retained query-trace storage.

Out of scope

Always-on query tracing, retained trace service, automatic replay, client auto-instrumentation, application trace sampling.

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.