[RCA] Sanitize metric evidence

未关闭
#14,231 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
38/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
go
领域
observability

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Java
星标
25k
派生
6.6k
平均合并
12 小时 1 分钟
30 天内合并 PR
43

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/skywalking 的其他 Issue

查看 apache/skywalking 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。