Extract benchmark functionality into standalone command #589

harp-intel · 2025-12-15T12:04:28Z

Summary

This PR extracts the benchmark functionality from the report command into a new standalone benchmark command, providing a cleaner separation of concerns and improved user experience.

Changes

New Benchmark Command (`cmd/benchmark/`)

Command structure: Follows the same flag pattern as the telemetry command
Flags: Individual flags for each benchmark type (--speed, --power, --temperature, --frequency, --memory, --numa, --storage)
Default behavior: Runs all benchmarks with --all (default: true)
System summary: Includes Brief System Summary table by default (can be excluded with --no-summary)

Files created:

cmd/benchmark/benchmark.go - Main command implementation
cmd/benchmark/benchmark_tables.go - Table definitions and data processing
cmd/benchmark/benchmark_renderers.go - HTML rendering functions
cmd/benchmark/benchmarking.go - Helper functions

Updated Report Command

Removed --benchmark flag
Removed benchmark table definitions
Removed benchmark data processing functions
Cleaned up unused imports

Files modified:

cmd/report/report.go
cmd/report/report_tables.go

Other Changes

Registered benchmark command in cmd/root.go
Updated README.md with new Benchmark Command section
Updated .github/copilot-instructions.md to include benchmark command

Usage

# Run all benchmarks (default)
perfspect benchmark

# Run specific benchmarks
perfspect benchmark --speed --power

# Exclude system summary
perfspect benchmark --no-summary

# Benchmark remote target
perfspect benchmark --target 192.168.1.1 --user user --key key_file

Testing

Code compiles successfully
Benchmark command appears in main help
Benchmark command help displays correctly
Report command no longer has benchmark flags
All flags follow telemetry command pattern
System summary included by default

Breaking Changes

⚠️ Breaking change: Users currently using perfspect report --benchmark will need to migrate to perfspect benchmark.

Benefits

Clearer separation between configuration reporting and performance benchmarking
Consistent flag pattern across commands (matches telemetry)
More discoverable - benchmarks are now a top-level command
Includes system context with Brief System Summary table

- Create new 'benchmark' command under cmd/benchmark/ - Implement benchmark flags following telemetry command pattern: * --all (default) - run all benchmarks * --speed, --power, --temperature, --frequency, --memory, --numa, --storage - Move benchmark table definitions and processing functions to new command - Move benchmark HTML renderers to new command - Remove benchmark functionality from report command: * Remove --benchmark flag * Remove benchmark table definitions * Remove benchmark data processing functions * Clean up unused imports - Register benchmark command in root command The benchmark command now provides a cleaner separation of concerns, following the same flag pattern as the telemetry command. Usage: perfspect benchmark # Runs all benchmarks perfspect benchmark --speed --power # Runs specific benchmarks perfspect benchmark --target <ip> # Benchmark remote target

- Add --no-summary flag to optionally exclude system summary - Include Brief System Summary table by default (like telemetry command) - System summary provides quick overview of target system configuration - Follows same pattern as telemetry command for consistency The system summary table shows key system information including: - Host name, time, CPU model, microarchitecture, TDP - Sockets, cores, hyperthreading, CPUs, NUMA nodes - Scaling driver/governor, C-states, frequencies - Energy settings, memory, NIC, disk, OS, kernel