[RCA] Sanitize metric evidence

オープン
#14,231 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
43

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

apache/skywalking のほかの issue

apache/skywalking の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。