mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-08 14:23:13 +00:00
feat: add ops profiler extension schema (#3628)
This commit is contained in:
@@ -5,16 +5,15 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
|
||||
## Current Context
|
||||
|
||||
- Issue: [`rustfs/backlog#660`](https://github.com/rustfs/backlog/issues/660)
|
||||
- Branch: `overtrue/arch-final-object-boundary-prune`
|
||||
- Baseline: stacked after `rustfs/rustfs#3622`
|
||||
(`4300bf04f3a82ef4cc2605f417f89e7b4643b99e`).
|
||||
- PR type for this branch: `consumer-migration`
|
||||
- Branch: `overtrue/arch-ops-profiler-schema`
|
||||
- Baseline: latest `origin/main`
|
||||
(`71809ba02ea405c3a2f0e4cb82ff608915dd519c`).
|
||||
- PR type for this branch: `contract`
|
||||
- Runtime behavior changes: none.
|
||||
- Rust code changes: route heal and RustFS storage object reader, writer,
|
||||
metadata, and options aliases through `rustfs_storage_api` associated types.
|
||||
- CI/script changes: shrink the remaining external `rustfs_ecstore::object_api`
|
||||
compatibility alias snapshot to empty.
|
||||
- Docs changes: record the API-071 final object boundary prune slice.
|
||||
- Rust code changes: define the `ops.profiler.v1` extension schema contract for
|
||||
profiler capability reporting, backend state, redaction, and provenance.
|
||||
- CI/script changes: none.
|
||||
- Docs changes: record the X-012 profiler schema contract slice.
|
||||
|
||||
## Phase 0 Tasks
|
||||
|
||||
@@ -1985,26 +1984,52 @@ Status values: `[ ]` not started, `[~]` in progress, `[x]` complete, `[!]` block
|
||||
checks, formatting, migration guards, Rust risk scan, branch freshness
|
||||
check, and pre-commit quality gate.
|
||||
|
||||
- [x] `X-012` Define ops profiler extension schema contract.
|
||||
- Do: add `ops.profiler.v1` capability DTOs for profiler backend status,
|
||||
capability-description mode, profile export redaction requirements, and
|
||||
provenance in the extension schema contract crate.
|
||||
- Acceptance: disabled, unsupported, enabled, and unknown backend states are
|
||||
representable; execution requests are rejected; profile export declarations
|
||||
require local path redaction; provenance records source, collection
|
||||
boundary, and trust level without credentials.
|
||||
- Must preserve: no plugin execution, no sidecar startup, no profile route or
|
||||
admin API behavior changes, no exporter/storage/object-path/telemetry
|
||||
behavior changes, and no dependency edge from `extension-schema` to
|
||||
implementation crates.
|
||||
- Verification: extension schema check/tests, formatting, migration/layer
|
||||
guards, diff hygiene, Rust risk scan, branch freshness check, and
|
||||
pre-commit quality gate.
|
||||
|
||||
## Next PRs
|
||||
|
||||
1. `pure-move`: continue larger lifecycle hook slices for optional runtime
|
||||
1. `contract`: continue larger extension contract coverage for disabled and
|
||||
unsupported runtime capability snapshots.
|
||||
2. `pure-move`: continue larger lifecycle hook slices for optional runtime
|
||||
sidecars while preserving startup and shutdown ordering.
|
||||
2. `consumer-migration`: continue larger cleanup slices with the
|
||||
loss-prevention guards active for remaining ECStore compatibility contracts
|
||||
that still have dedicated preservation coverage.
|
||||
|
||||
## Pre-Push Review Log
|
||||
|
||||
| Expert | Status | Notes |
|
||||
|---|---|---|
|
||||
| Quality/architecture | passed | R-020 moves profiling init/shutdown call sites behind `startup_profiling` hook functions without moving CPU/memory profiling implementation ownership or admin pprof APIs. |
|
||||
| Migration preservation | passed | BOOT-006 still initializes profiling before trusted proxies/provider/TLS setup; STOP-004 still stops profiling after notifier/audit shutdown and before HTTP shutdown; profiling env flags, platform gates, target unsupported behavior, and cancellation-token ownership remain in `profiling.rs`. |
|
||||
| Testing/verification | passed | Focused startup profiling hook tests, RustFS library check, migration/layer guards, formatting, diff hygiene, Rust risk scan, and full `make pre-commit` validate the current R-020 slice. |
|
||||
| Quality/architecture | passed | X-012 keeps the profiler schema in `rustfs-extension-schema`, uses explicit backend/status/redaction/provenance DTOs, and adds no new dependency edges or runtime abstractions. |
|
||||
| Migration preservation | passed | Runtime profiling, admin pprof routes, exporters, storage paths, telemetry, sidecar startup, and plugin execution are untouched; the new contract only describes capabilities. |
|
||||
| Testing/verification | passed | Extension schema tests cover enabled, disabled, unsupported, unknown, missing-field, redaction, provenance, and credential-field rejection; focused checks, guards, formatting, diff hygiene, and final pre-commit passed. |
|
||||
|
||||
## Verification Notes
|
||||
|
||||
Passed before push:
|
||||
|
||||
- Issue #660 X-012 current slice:
|
||||
- `cargo test -p rustfs-extension-schema`: passed.
|
||||
- `cargo check -p rustfs-extension-schema`: passed.
|
||||
- `./scripts/check_architecture_migration_rules.sh`: passed.
|
||||
- `./scripts/check_layer_dependencies.sh`: passed.
|
||||
- `cargo fmt --all --check`: passed.
|
||||
- `git diff --check`: passed.
|
||||
- Rust risk scan on changed Rust files: passed.
|
||||
- `make pre-commit`: passed.
|
||||
- Three-expert review: passed.
|
||||
|
||||
- Issue #660 R-020 current slice:
|
||||
- `cargo test -p rustfs --lib startup_profiling -- --nocapture`: passed.
|
||||
- `cargo check -p rustfs --lib`: passed.
|
||||
|
||||
@@ -66,9 +66,12 @@ Future sidecars for profiling, eBPF, or NUMA must preserve these invariants:
|
||||
|
||||
`X-012`:
|
||||
|
||||
- Add an optional profiling/eBPF extension point that can observe capability
|
||||
status.
|
||||
- Keep unsupported targets and disabled sidecars as no-op.
|
||||
- Define the `ops.profiler.v1` extension schema for profiling capability
|
||||
reporting, backend status, redaction requirements, and provenance.
|
||||
- Keep the schema capability-only; it must not request profiler execution,
|
||||
start sidecars, or change profile export behavior.
|
||||
- Keep unsupported targets, disabled sidecars, and unknown future backends
|
||||
representable as no-op capability states.
|
||||
|
||||
`X-013`:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user