summaryrefslogtreecommitdiff
path: root/benchmarks/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-06-26 22:40:27 +0300
committerPaul Buetow <paul@buetow.org>2025-06-26 22:40:27 +0300
commitafba86489b00a2f5ac4d39b2853c2c51c2931536 (patch)
tree934ab9c6805dbc17bf71cd4b30f827c10a58a192 /benchmarks/README.md
parent91e4743ce5ddab8f6359009bb45e243d4726bcdb (diff)
Remove bash scripts and update documentation to use dtail-tools
Following the successful refactoring to Go-based tooling, this commit: 1. Removes all obsolete bash scripts: - benchmarks/benchmark.sh - profiling/profile.sh - profiling/profile_benchmarks.sh - profiling/profile_dmap.sh - profiling/profile_quick.sh 2. Updates all documentation to use dtail-tools: - README.md: Updated benchmark commands to use dtail-tools - PROFILING.md: Updated profiling instructions to use dtail-tools 3. Updates Go code references: - profile_runner.go: Uses dtail-tools instead of profile.sh - profile_example.go: Uses dtail-tools for profile analysis The new dtail-tools provides all the functionality of the old bash scripts with better cross-platform compatibility, error handling, and maintainability. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'benchmarks/README.md')
-rw-r--r--benchmarks/README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/benchmarks/README.md b/benchmarks/README.md
index dfb2627..3494086 100644
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -40,13 +40,13 @@ make benchmark-baseline
make benchmark-baseline-quick
# Create a baseline with a descriptive tag (no prompt)
-./benchmarks/benchmark.sh baseline --tag "before-optimization"
+./dtail-tools benchmark -mode baseline -tag "before-optimization"
# Create a baseline interactively (will prompt if no tag provided)
-./benchmarks/benchmark.sh baseline
+make benchmark-baseline
# Create a comprehensive baseline (3x iterations)
-./benchmarks/benchmark.sh full-baseline --tag "v1.0-release"
+./dtail-tools benchmark -mode baseline -iterations 3x -tag "v1.0-release"
```
### Comparing Performance
@@ -55,10 +55,10 @@ make benchmark-baseline-quick
make benchmark-compare BASELINE=benchmarks/baselines/baseline_20240125_143022.txt
# Use the benchmark script for more options
-./benchmarks/benchmark.sh compare benchmarks/baselines/baseline_20240125_143022.txt
+./dtail-tools benchmark -mode compare -baseline benchmarks/baselines/baseline_20240125_143022.txt
# List available baselines
-./benchmarks/benchmark.sh list
+./dtail-tools benchmark -mode list
```
### Specific Tool Benchmarks
@@ -183,10 +183,10 @@ make benchmark-baseline-quick
> Enter a descriptive name for this baseline: initial-performance-check
# Tagged baseline with description (no prompt)
-./benchmarks/benchmark.sh baseline --tag "before-refactoring"
+./dtail-tools benchmark -mode baseline -tag "before-refactoring"
# Full baseline with multiple iterations
-./benchmarks/benchmark.sh full-baseline --memory --tag "release-v2.0"
+./dtail-tools benchmark -mode baseline -iterations 3x -memory -tag "release-v2.0"
```
Baseline files are named with the pattern:
@@ -200,19 +200,19 @@ Compare current performance against a baseline to detect regressions or improvem
make benchmark-compare BASELINE=benchmarks/baselines/baseline_20240125_143022.txt
# Using benchmark script (provides benchstat analysis if available)
-./benchmarks/benchmark.sh compare benchmarks/baselines/baseline_20240125_143022.txt
+./dtail-tools benchmark -mode compare -baseline benchmarks/baselines/baseline_20240125_143022.txt
```
### Managing Baselines
```bash
# List all baselines
-./benchmarks/benchmark.sh list
+./dtail-tools benchmark -mode list
# View a specific baseline
-./benchmarks/benchmark.sh show benchmarks/baselines/baseline_20240125_143022.txt
+cat benchmarks/baselines/baseline_20240125_143022.txt
# Clean old baselines (keeps last 10)
-./benchmarks/benchmark.sh clean
+./dtail-tools benchmark -mode clean
```
### Best Practices for Baselines