docs consolidation work
This commit is contained in:
50
docs/modules/benchmark/README.md
Normal file
50
docs/modules/benchmark/README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Benchmark
|
||||
|
||||
**Status:** Implemented
|
||||
**Source:** `src/Bench/`
|
||||
**Owner:** Platform Team
|
||||
|
||||
## Purpose
|
||||
|
||||
Benchmark provides performance testing and regression analysis for StellaOps components. Ensures deterministic scan times, throughput validation, and performance profiling for critical paths (scanning, policy evaluation, SBOM generation).
|
||||
|
||||
## Components
|
||||
|
||||
**Services:**
|
||||
- `StellaOps.Bench` - Benchmarking harness with BenchmarkDotNet integration
|
||||
|
||||
**Key Features:**
|
||||
- Scanner performance benchmarks (per-analyzer, full-scan)
|
||||
- Policy engine evaluation latency tests
|
||||
- SBOM generation throughput tests
|
||||
- Database query performance profiling
|
||||
- Determinism validation (output stability)
|
||||
|
||||
## Configuration
|
||||
|
||||
Benchmark configuration via BenchmarkDotNet attributes and runtime parameters.
|
||||
|
||||
Key settings:
|
||||
- Benchmark filters and categories
|
||||
- Iterations and warmup counts
|
||||
- Memory profiling and allocation tracking
|
||||
- Export formats (JSON, HTML, Markdown)
|
||||
|
||||
## Dependencies
|
||||
|
||||
- BenchmarkDotNet framework
|
||||
- Scanner (benchmark targets)
|
||||
- Policy Engine (benchmark targets)
|
||||
- SbomService (benchmark targets)
|
||||
- Test fixtures and datasets
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- Architecture: `./architecture.md`
|
||||
- Scanner: `../scanner/`
|
||||
- Policy: `../policy/`
|
||||
- Operations: `./operations/` (if exists)
|
||||
|
||||
## Current Status
|
||||
|
||||
Implemented with BenchmarkDotNet harness. Provides performance baselines for scanner analyzers, policy evaluation, and SBOM generation. Used for regression detection in CI/CD pipeline.
|
||||
Reference in New Issue
Block a user