[RCA] Sanitize metric evidence

Abierto
#14,231 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Java
Estrellas
25k
Forks
6.6k
Merge medio
12 h 1 min
PR fusionados (30 d)
43

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/skywalking

Todos los issues de apache/skywalking

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.