Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions .claude/skills/benchmark/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ go run . -benchnum 5

Multi-component snapshot with configurable parallelism:

```bash
make benchmark_stress
```

Or manually:

```bash
cd benchmark/stress
./prepare_data.sh
Expand All @@ -69,7 +75,30 @@ EC_STRESS_COMPONENTS=50 EC_STRESS_WORKERS=20 go run .

Defaults: 10 components, 35 workers.

## Step 5: Profile if needed
## Step 5: Compare against baseline

The stress benchmark has regression detection. After running:

```bash
cd benchmark/stress
./compare.sh benchmark-output.txt
```

This compares current results against `baseline.json` using thresholds from
`thresholds.json` (default: 15% RSS, 20% ns/op). Exits non-zero on regression.

## Step 6: Regenerate baseline

After intentional performance changes, update the stored baseline:

```bash
make generate-baseline
```

This runs the stress benchmark, parses results, and writes `benchmark/stress/baseline.json`
with current metrics, commit SHA, date, and Go version.

## Step 7: Profile if needed

Use the CLI's built-in profiling:

Expand All @@ -79,7 +108,7 @@ ec validate image --trace=cpu ... # pprof CPU profile
ec validate image --trace=mem ... # heap profile
```

## Step 6: Report results
## Step 8: Report results

Output is in standard Go benchmark format (ns/op, memory stats). Summarize:
- Benchmark type run (simple/stress)
Expand Down
70 changes: 57 additions & 13 deletions .github/workflows/benchmark.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ jobs:
name: Stress Benchmark
runs-on: ubuntu-latest
timeout-minutes: 15
continue-on-error: true
env:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[medium] logic-error

Removing continue-on-error: true from the job level converts the benchmark from an advisory check into a blocking gate. With a single iteration and no statistical averaging or retry mechanism, noisy CI environments may produce false positive regressions that block PRs. The 15% RSS and 20% ns/op thresholds are reasonably generous but may not absorb CI-inherent variance in all cases.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] scope-creep

The operational impact of converting the benchmark from advisory to blocking is not explicitly called out in the PR description. The PR title implies regression detection, but the enforcement posture change could surprise operators.

# Tuned for 4 vCPU / 16 GB CI runners to complete within 5 minutes.
Comment thread
dheerajodha marked this conversation as resolved.
# Code defaults are 10 components / 35 workers.
Expand Down Expand Up @@ -73,11 +72,23 @@ jobs:

- name: Run stress benchmark
id: bench
continue-on-error: true
run: |
set -o pipefail
cd benchmark/stress
./stress 2>benchmark-stderr.txt | tee benchmark-output.txt

- name: Compare against baseline
id: compare
Comment thread
dheerajodha marked this conversation as resolved.
if: steps.bench.outcome == 'success'
run: |
cd benchmark/stress
if [[ -f baseline.json ]]; then
./compare.sh benchmark-output.txt
else
echo "No baseline found, skipping comparison."
fi

- name: Write job summary
if: always()
run: |
Expand All @@ -103,25 +114,58 @@ jobs:
exit 0
fi

ns_op=$(echo "$line" | grep -oP '[\d.]+ ns/op' | awk '{print $1}')
peak_rss=$(echo "$line" | grep -oP '[\d.]+ peak-RSS-bytes' | awk '{print $1}')
alloc=$(echo "$line" | grep -oP '[\d.]+ allocated-bytes/op' | awk '{print $1}')
heap=$(echo "$line" | grep -oP '[\d.]+ heap-bytes-from-system' | awk '{print $1}')
read -r ns_op peak_rss alloc heap < <(BENCH_LINE="$line" python3 -c "
Comment thread
dheerajodha marked this conversation as resolved.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] code-duplication

Benchmark output parsing (regex extraction of ns/op, peak-RSS-bytes) is duplicated across compare.sh, the workflow summary step, and the Makefile target. If the benchmark output format changes, all three must be updated.

import os, re
Comment thread
dheerajodha marked this conversation as resolved.
Comment thread
dheerajodha marked this conversation as resolved.
line = os.environ['BENCH_LINE']
def val(p):
m = re.search(p, line)
return m.group(1) if m else '0'
print(val(r'([\d.]+)\s+ns/op'), val(r'([\d.]+)\s+peak-RSS-bytes'), val(r'([\d.]+)\s+allocated-bytes/op'), val(r'([\d.]+)\s+heap-bytes-from-system'))
")

secs=$(awk -v val="${ns_op:-0}" 'BEGIN {printf "%.1f", val / 1000000000}')
rss_mb=$(awk -v val="${peak_rss:-0}" 'BEGIN {printf "%.0f", val / 1048576}')
alloc_mb=$(awk -v val="${alloc:-0}" 'BEGIN {printf "%.0f", val / 1048576}')
heap_mb=$(awk -v val="${heap:-0}" 'BEGIN {printf "%.0f", val / 1048576}')

has_baseline=false

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] error-handling-gap

The job summary's baseline comparison divides by bl_rss and bl_ns without a zero-value guard. compare.sh has this guard (line 69); the workflow summary code path does not.

if [[ -f benchmark/stress/baseline.json ]]; then
has_baseline=true
bl_rss=$(python3 -c "import json; print(json.load(open('benchmark/stress/baseline.json'))['peak_rss_bytes'])")
bl_ns=$(python3 -c "import json; print(json.load(open('benchmark/stress/baseline.json'))['ns_per_op'])")
Comment thread
dheerajodha marked this conversation as resolved.
bl_rss_mb=$(awk -v val="$bl_rss" 'BEGIN {printf "%.0f", val / 1048576}')
bl_secs=$(awk -v val="$bl_ns" 'BEGIN {printf "%.1f", val / 1000000000}')
rss_change=$(awk -v cur="$peak_rss" -v base="$bl_rss" 'BEGIN {printf "%+.1f", ((cur - base) / base) * 100}')
time_change=$(awk -v cur="$ns_op" -v base="$bl_ns" 'BEGIN {printf "%+.1f", ((cur - base) / base) * 100}')
fi

{
echo "## Stress Benchmark"
echo ""
echo "| Metric | Value | Description |"
echo "|--------|-------|-------------|"
echo "| Components | ${EC_STRESS_COMPONENTS} | Snapshot components validated |"
echo "| Workers | ${EC_STRESS_WORKERS} | Parallel validation workers |"
echo "| Execution time | ${secs}s | Wall-clock time per iteration |"
echo "| Peak RSS | ${rss_mb} MB | Max physical memory used |"
echo "| Allocated memory | ${alloc_mb} MB | Total Go heap allocations |"
echo "| Heap from system | ${heap_mb} MB | Heap memory requested from OS |"
if [[ "$has_baseline" == "true" ]]; then
echo "| Metric | Current | Baseline | Change | Description |"
echo "|--------|---------|----------|--------|-------------|"
echo "| Components | ${EC_STRESS_COMPONENTS} | | | Snapshot components validated |"
echo "| Workers | ${EC_STRESS_WORKERS} | | | Parallel validation workers |"
echo "| Execution time | ${secs}s | ${bl_secs}s | ${time_change}% | Wall-clock time per iteration |"
echo "| Peak RSS | ${rss_mb} MB | ${bl_rss_mb} MB | ${rss_change}% | Max physical memory used |"
echo "| Allocated memory | ${alloc_mb} MB | | | Total Go heap allocations |"
echo "| Heap from system | ${heap_mb} MB | | | Heap memory requested from OS |"
else
echo "| Metric | Value | Description |"
echo "|--------|-------|-------------|"
echo "| Components | ${EC_STRESS_COMPONENTS} | Snapshot components validated |"
echo "| Workers | ${EC_STRESS_WORKERS} | Parallel validation workers |"
echo "| Execution time | ${secs}s | Wall-clock time per iteration |"
echo "| Peak RSS | ${rss_mb} MB | Max physical memory used |"
echo "| Allocated memory | ${alloc_mb} MB | Total Go heap allocations |"
echo "| Heap from system | ${heap_mb} MB | Heap memory requested from OS |"
fi
if [[ "${{ steps.compare.outcome }}" == "failure" ]]; then
echo ""
echo "> **⚠️ Performance regression detected.** Update the baseline with \`make generate-baseline\` if this is expected."
elif [[ "${{ steps.compare.outcome }}" == "skipped" ]]; then
echo ""
echo "> **ℹ️ Baseline comparison skipped** because the benchmark step failed."
fi
} >> "$GITHUB_STEP_SUMMARY"
20 changes: 20 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,26 @@ Acceptance tests require `/etc/hosts` entries:
127.0.0.1 rekor.localhost
```

## Benchmarks

Two benchmarks live under `benchmark/`:

- **simple/** — Single-component validation against the `@redhat` policy collection.
- **stress/** — Multi-component validation with configurable parallelism
(`EC_STRESS_COMPONENTS`, `EC_STRESS_WORKERS`).

```bash
make benchmark # Run simple benchmark
make benchmark_stress # Run stress benchmark (via pattern rule)
make generate-baseline # Run stress benchmark and write baseline.json
```

The stress benchmark has regression detection: `benchmark/stress/baseline.json` stores
reference metrics (peak RSS, ns/op) and `benchmark/stress/thresholds.json` defines
percentage thresholds. CI runs `benchmark/stress/compare.sh` to compare each run
against the baseline and fails the check on regression. Update the baseline with
`make generate-baseline` after intentional performance changes.

## Single-File Verification

```bash
Expand Down
23 changes: 23 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,29 @@ benchmark_data: benchmark/simple/data.tar.gz ## Prepare data for benchmark
.PHONY: benchmark
benchmark: benchmark_simple ## Run benchmarks

Comment thread
dheerajodha marked this conversation as resolved.
.PHONY: generate-baseline
Comment thread
dheerajodha marked this conversation as resolved.
Comment thread
dheerajodha marked this conversation as resolved.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] naming-convention

The target generate-baseline uses hyphens while existing benchmark targets use underscores (benchmark_data, benchmark_stress). Other Makefile targets use hyphens (lint-fix, tools-ci), so this is a minor inconsistency rather than a clear violation.

generate-baseline: benchmark/stress/data.tar.gz ## Generate stress benchmark baseline
Comment thread
dheerajodha marked this conversation as resolved.
@cd benchmark/stress && \
EC_STRESS_COMPONENTS=$${EC_STRESS_COMPONENTS:-10} EC_STRESS_WORKERS=$${EC_STRESS_WORKERS:-10} \
go run . 2>benchmark-stderr.txt | tee benchmark-output.txt && \
Comment thread
coderabbitai[bot] marked this conversation as resolved.
python3 -c "\
import re, json, sys; \
Comment thread
dheerajodha marked this conversation as resolved.
line = [l for l in open('benchmark-output.txt') if l.startswith('BenchmarkStress')]; \
line or sys.exit('No BenchmarkStress results found'); \
line = line[0]; \
def val(p): \
m = re.search(p, line); \
return m.group(1) if m else ''; \
ns = val(r'([\d.]+)\s+ns/op'); rss = val(r'([\d.]+)\s+peak-RSS-bytes'); \
(ns and rss) or sys.exit('Failed to parse benchmark metrics'); \
json.dump({'peak_rss_bytes': int(float(rss)), 'ns_per_op': int(float(ns)), \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] edge-case

The generate-baseline target embeds $(shell ...) expansions inside a Python string literal. Any unexpected character in the output (e.g., a single quote from a future Go version string) could break Python syntax. Consider passing these values via environment variables.

'components': int('$${EC_STRESS_COMPONENTS:-10}'), 'workers': int('$${EC_STRESS_WORKERS:-10}'), \
'commit': '$(shell git rev-parse --short HEAD)', 'date': '$(shell date -u +%Y-%m-%d)', \
'go_version': '$(shell go env GOVERSION | sed "s/^go//")' \
}, open('baseline.json','w'), indent=2); print()" && \
rm -f benchmark-output.txt benchmark-stderr.txt && \
echo "Baseline written to benchmark/stress/baseline.json"

.PHONY: tools-ci
tools-ci: ## Ensure all tools build cleanly
@echo "• tkn:" && \
Expand Down
22 changes: 22 additions & 0 deletions benchmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,25 @@ times.
- **stress/** — Multi-component validation with configurable parallelism. Set
`EC_STRESS_COMPONENTS` (default 10) and `EC_STRESS_WORKERS` (default 35) to
control the workload.

## Baseline and regression detection

The stress benchmark stores a performance baseline in
`stress/baseline.json` (peak RSS and ns/op) along with configurable
regression thresholds in `stress/thresholds.json`. The CI workflow
compares each run against the baseline and fails the check when a metric
exceeds its threshold.

To regenerate the baseline after an intentional change:

```
make generate-baseline
```

This runs the stress benchmark locally, parses the results, and writes a
new `baseline.json` with the current commit SHA, date, Go version, and
worker/component counts.

Thresholds are expressed as percentages (e.g., 15 means a 15% increase
triggers a failure). Adjust them in `stress/thresholds.json` as
optimizations land.
9 changes: 9 additions & 0 deletions benchmark/stress/baseline.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"peak_rss_bytes": 2250485760,
"ns_per_op": 2567888013,
"components": 10,
"workers": 10,
"commit": "fc37eb13",
"date": "2026-08-11",
"go_version": "1.26.3"
}
108 changes: 108 additions & 0 deletions benchmark/stress/compare.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
#!/bin/bash
# Copyright The Conforma Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

# Compares current benchmark results against a stored baseline and exits
# non-zero if any metric regresses beyond the configured threshold.
set -o errexit
set -o nounset
set -o pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
BASELINE="${SCRIPT_DIR}/baseline.json"
THRESHOLDS="${SCRIPT_DIR}/thresholds.json"
BENCHMARK_OUTPUT="${1:-${SCRIPT_DIR}/benchmark-output.txt}"

if [[ ! -f "$BASELINE" ]]; then
echo "No baseline found, skipping comparison."
exit 0
fi
Comment thread
dheerajodha marked this conversation as resolved.

if [[ ! -f "$THRESHOLDS" ]]; then
echo "No thresholds file found, skipping comparison."
exit 0
fi
Comment thread
dheerajodha marked this conversation as resolved.

if [[ ! -f "$BENCHMARK_OUTPUT" ]]; then
echo "No benchmark output found at ${BENCHMARK_OUTPUT}"
exit 1
fi

line=$(grep '^BenchmarkStress' "$BENCHMARK_OUTPUT" || true)
if [[ -z "$line" ]]; then
Comment thread
dheerajodha marked this conversation as resolved.
echo "No BenchmarkStress results found in output."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] edge-case

If the benchmark output contains multiple BenchmarkStress lines, grep captures all of them. Python's re.search finds the first match, silently discarding subsequent lines. Consider grep -m1 to be explicit about taking only the first match.

Suggested fix: Use grep -m1 '^BenchmarkStress' to explicitly take only the first match, and log a warning if multiple lines exist.

exit 1
fi
Comment thread
dheerajodha marked this conversation as resolved.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] error-handling-gap

If the python3 process substitution produces partial output, read could succeed with some variables empty, causing awk to silently treat them as 0. Adding a validation guard after read (checking all six variables are non-empty) would improve robustness.

Suggested fix: After the read command, add: [[ -n "$current_ns" && -n "$current_rss" && -n "$baseline_ns" && -n "$baseline_rss" && -n "$threshold_rss" && -n "$threshold_time" ]] || { echo 'Failed to parse metrics'; exit 1; }

read -r current_ns current_rss baseline_ns baseline_rss threshold_rss threshold_time < <(
BENCH_LINE="${line}" BASELINE_PATH="${BASELINE}" THRESHOLDS_PATH="${THRESHOLDS}" python3 -c "
Comment thread
dheerajodha marked this conversation as resolved.
import json, os, re, sys
line = os.environ['BENCH_LINE']
def extract(pattern):
m = re.search(pattern, line)
return m.group(1) if m else ''
ns = extract(r'([\d.]+)\s+ns/op')
rss = extract(r'([\d.]+)\s+peak-RSS-bytes')
Comment thread
dheerajodha marked this conversation as resolved.
if not ns or not rss:
print('Failed to parse benchmark metrics from output.', file=sys.stderr)
sys.exit(1)
b = json.load(open(os.environ['BASELINE_PATH']))
t = json.load(open(os.environ['THRESHOLDS_PATH']))
print(ns, rss, b['ns_per_op'], b['peak_rss_bytes'], t['peak_rss_percent'], t['ns_per_op_percent'])
Comment thread
coderabbitai[bot] marked this conversation as resolved.
"
Comment thread
dheerajodha marked this conversation as resolved.
)

if awk -v rss="$baseline_rss" -v ns="$baseline_ns" 'BEGIN {exit !(rss==0 || ns==0)}'; then
Comment thread
dheerajodha marked this conversation as resolved.
echo "Baseline contains zero values, cannot compute regression."
Comment thread
dheerajodha marked this conversation as resolved.
exit 1
fi

rss_change=$(awk -v cur="$current_rss" -v base="$baseline_rss" 'BEGIN {printf "%.1f", ((cur - base) / base) * 100}')
time_change=$(awk -v cur="$current_ns" -v base="$baseline_ns" 'BEGIN {printf "%.1f", ((cur - base) / base) * 100}')

baseline_rss_mb=$(awk -v val="$baseline_rss" 'BEGIN {printf "%.0f", val / 1048576}')
current_rss_mb=$(awk -v val="$current_rss" 'BEGIN {printf "%.0f", val / 1048576}')
baseline_secs=$(awk -v val="$baseline_ns" 'BEGIN {printf "%.1f", val / 1000000000}')
current_secs=$(awk -v val="$current_ns" 'BEGIN {printf "%.1f", val / 1000000000}')

echo ""
echo "=== Benchmark Comparison ==="
echo ""
printf "%-20s %10s %10s %10s %10s\n" "Metric" "Baseline" "Current" "Change" "Threshold"
printf "%-20s %10s %10s %9s%% %9s%%\n" "Peak RSS" "${baseline_rss_mb} MB" "${current_rss_mb} MB" "$rss_change" "$threshold_rss"
printf "%-20s %10s %10s %9s%% %9s%%\n" "Execution time" "${baseline_secs}s" "${current_secs}s" "$time_change" "$threshold_time"
echo ""

failed=0

rss_exceeded=$(awk -v change="$rss_change" -v thresh="$threshold_rss" 'BEGIN {print (change > thresh) ? 1 : 0}')
time_exceeded=$(awk -v change="$time_change" -v thresh="$threshold_time" 'BEGIN {print (change > thresh) ? 1 : 0}')

if [[ "$rss_exceeded" == "1" ]]; then
echo "FAIL: Peak RSS regressed by ${rss_change}% (threshold: ${threshold_rss}%)"
failed=1
fi

if [[ "$time_exceeded" == "1" ]]; then
echo "FAIL: Execution time regressed by ${time_change}% (threshold: ${threshold_time}%)"
failed=1
fi

if [[ "$failed" == "0" ]]; then
echo "PASS: No regressions detected."
fi

exit "$failed"
4 changes: 4 additions & 0 deletions benchmark/stress/thresholds.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"peak_rss_percent": 15,
"ns_per_op_percent": 20
}
Loading