[RCA] Sanitize metric evidence

Open
#14,231 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
observability

Research direction

The issue identifies the bydbctl rca sanitize command and the RCA sanitization package as the change area; its prerequisite issues #14225 and #14230 must merge and define the exact metric format and policy contract first. Read those issues and inspect the existing sanitizer command seam, then use an independent fixture to verify the allowlist, aliasing, timestamps, values, units, exclusions, and incomplete coverage. Done means the CLI fails closed on malformed samples, bounds input and output, and leaves raw evidence unchanged.

Written by the indexing model from the issue text.

Description

database enhancement metrics

Umbrella: #14222

Blocked by: #14225, #14230

Summary

Metrics collected by #14225 need a safe public representation.

Boundary

Activation: bydbctl rca sanitize --selection … --policy …. Extend the same CLI and policy contract, not a new service.
Commands are proposed, not implemented. No database storage/wire-format changes.

Requirements

R1. Extend the sanitizer caller from #14230 for the metric format produced by #14225 only.
R2. Allowlist metric names and label keys; alias approved identity labels through the existing incident mapping. Drop unknown labels and free-text metadata.
R3. Preserve allowed sample timestamps, numeric values and units; retain coverage gaps without exposing private names.
R4. Reject malformed samples and record exclusions; do not alter raw evidence or create a second policy engine.

Acceptance criteria

  • An independent sample fixture verifies exact values/units/timestamps, removal of a secret label and consistent node aliasing with a log fixture.
  • Malformed samples fail closed and absent-agent coverage remains explicitly incomplete.
  • Invoke the actual sanitizer CLI; maintain independent golden fixtures, not expected values produced by the implementation under test.
  • Bound input/output sizes and leave raw evidence unchanged on success and failure. Unknown artifact types never bypass policy.
  • Add a test-only patch using a merged CLI seam that fails by assertion on the base, then passes with the implementation.

Scope and readiness audit

  • Classification: planned blocked leaf; not ready for GraphLoom until prerequisites merge and exact format/policy contracts are fixed.
  • Dependencies: #14225, #14230
  • Boundary and production activation: one typed transformation via the existing sanitizer command.
  • Scope: bydbctl RCA sanitization package and command; one independent format fixture family.
  • RED evidence: not executed in this drafting task. Plan a named TestRCA test through an existing command seam, not an import of new production APIs.
  • Focused tests: run the selected Go regression and changed-package tests after generation; exact selector must be fixed before queueing.
  • End-to-end proof: selected private artifact to expected candidate derivative plus exclusion report.
  • Compatibility/lifecycle: existing supported artifacts remain valid; preserve cancellation, size bounds, output isolation and alias consistency.
  • Decision: one proposed PR after the merged seam is revalidated; no model needed for safety decisions.

Required-only scope audit

Metrics collected by #14225 need a safe public representation. Format support is deliberately limited to the corresponding collector. No generalized arbitrary-content sanitization.

Out of scope

Raw pprof/core/database file release, automatic publication, AI-only sanitization, generic secret-detection guarantees and new telemetry capture.

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.