Files
next.orly.dev/scripts/benchmark.sh
mleku fad39ec201
Some checks failed
Go / build-and-release (push) Has been cancelled
Add serve mode, fix binary tags, document CLI tools, improve Docker
- Add 'serve' subcommand for ephemeral RAM-based relay at /dev/shm with
  open ACL mode for testing and benchmarking
- Fix e-tag and p-tag decoding to use ValueHex()/ValueBinary() methods
  instead of Value() which returns raw bytes for binary-optimized storage
- Document all command-line tools in readme.adoc (relay-tester, benchmark,
  stresstest, blossomtest, aggregator, convert, FIND, policytest, etc.)
- Switch Docker images from Alpine to Debian for proper libsecp256k1
  Schnorr signature and ECDH support required by Nostr
- Upgrade Docker Go version from 1.21 to 1.25
- Add ramdisk mode (--ramdisk) to benchmark script for eliminating disk
  I/O bottlenecks in performance measurements
- Add docker-compose.ramdisk.yml for tmpfs-based benchmark volumes
- Add test coverage for privileged policy with binary-encoded p-tags
- Fix blossom test to expect 200 OK for anonymous uploads when auth is
  not required (RequireAuth=false with ACL mode 'none')
- Update follows ACL to handle both binary and hex p-tag formats
- Grant owner access to all users in serve mode via None ACL
- Add benchmark reports from multi-relay comparison run
- Update CLAUDE.md with binary tag handling documentation
- Bump version to v0.30.2
2025-11-26 09:52:29 +00:00

176 lines
6.2 KiB
Bash
Executable File

#!/bin/bash
set -euo pipefail
# scripts/benchmark.sh - Run full benchmark suite on a relay at a configurable address
#
# Usage:
# ./scripts/benchmark.sh [relay_address] [relay_port]
#
# Example:
# ./scripts/benchmark.sh localhost 3334
# ./scripts/benchmark.sh nostr.example.com 8080
#
# If relay_address and relay_port are not provided, defaults to localhost:3334
SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
REPO_ROOT="$(cd -- "${SCRIPT_DIR}/.." && pwd)"
cd "$REPO_ROOT"
# Default values
RELAY_ADDRESS="${1:-localhost}"
RELAY_PORT="${2:-3334}"
RELAY_URL="ws://${RELAY_ADDRESS}:${RELAY_PORT}"
BENCHMARK_EVENTS="${BENCHMARK_EVENTS:-10000}"
BENCHMARK_WORKERS="${BENCHMARK_WORKERS:-8}"
BENCHMARK_DURATION="${BENCHMARK_DURATION:-60s}"
REPORTS_DIR="${REPORTS_DIR:-$REPO_ROOT/cmd/benchmark/reports}"
TIMESTAMP=$(date +"%Y%m%d_%H%M%S")
RUN_DIR="${REPORTS_DIR}/run_${TIMESTAMP}"
# Ensure the benchmark binary is built
BENCHMARK_BIN="${REPO_ROOT}/cmd/benchmark/benchmark"
if [[ ! -x "$BENCHMARK_BIN" ]]; then
echo "Building benchmark binary (pure Go + purego)..."
cd "$REPO_ROOT/cmd/benchmark"
CGO_ENABLED=0 go build -o "$BENCHMARK_BIN" .
# Copy libsecp256k1.so from repo root (runtime optional)
if [[ -f "$REPO_ROOT/libsecp256k1.so" ]]; then
cp "$REPO_ROOT/libsecp256k1.so" "$(dirname "$BENCHMARK_BIN")/"
chmod +x "$(dirname "$BENCHMARK_BIN")/libsecp256k1.so" 2>/dev/null || true
fi
cd "$REPO_ROOT"
fi
# Create output directory
mkdir -p "${RUN_DIR}"
echo "=================================================="
echo "Nostr Relay Benchmark"
echo "=================================================="
echo "Timestamp: $(date)"
echo "Target Relay: ${RELAY_URL}"
echo "Events per test: ${BENCHMARK_EVENTS}"
echo "Concurrent workers: ${BENCHMARK_WORKERS}"
echo "Test duration: ${BENCHMARK_DURATION}"
echo "Output directory: ${RUN_DIR}"
echo "=================================================="
# Function to wait for relay to be ready
wait_for_relay() {
local url="$1"
local max_attempts=30
local attempt=0
echo "Waiting for relay to be ready at ${url}..."
while [ $attempt -lt $max_attempts ]; do
# Try to get HTTP status code with curl
local status=$(curl -s -o /dev/null -w "%{http_code}" --connect-timeout 5 --max-time 5 "http://${RELAY_ADDRESS}:${RELAY_PORT}" || echo 000)
case "$status" in
101|200|400|404|426)
echo "Relay is ready! (HTTP ${status})"
return 0
;;
esac
attempt=$((attempt + 1))
echo " Attempt ${attempt}/${max_attempts}: Relay not ready yet (HTTP ${status})..."
sleep 2
done
echo "ERROR: Relay failed to become ready after ${max_attempts} attempts"
return 1
}
# Function to run benchmark against the relay
run_benchmark() {
local output_file="${RUN_DIR}/benchmark_results.txt"
echo ""
echo "=================================================="
echo "Testing relay at ${RELAY_URL}"
echo "=================================================="
# Wait for relay to be ready
if ! wait_for_relay "${RELAY_ADDRESS}:${RELAY_PORT}"; then
echo "ERROR: Relay is not responding, aborting..."
echo "RELAY_URL: ${RELAY_URL}" > "${output_file}"
echo "STATUS: FAILED - Relay not responding" >> "${output_file}"
echo "ERROR: Connection failed" >> "${output_file}"
return 1
fi
# Run the benchmark
echo "Running benchmark against ${RELAY_URL}..."
# Create temporary directory for benchmark data
TEMP_DATA_DIR="/tmp/benchmark_${TIMESTAMP}"
mkdir -p "${TEMP_DATA_DIR}"
# Run benchmark and capture both stdout and stderr
if "${BENCHMARK_BIN}" \
-relay-url="${RELAY_URL}" \
-datadir="${TEMP_DATA_DIR}" \
-events="${BENCHMARK_EVENTS}" \
-workers="${BENCHMARK_WORKERS}" \
-duration="${BENCHMARK_DURATION}" \
# > "${output_file}"
2>&1; then
echo "✓ Benchmark completed successfully"
# Add relay identification to the report
echo "" >> "${output_file}"
echo "RELAY_URL: ${RELAY_URL}" >> "${output_file}"
echo "TEST_TIMESTAMP: $(date -Iseconds)" >> "${output_file}"
echo "BENCHMARK_CONFIG:" >> "${output_file}"
echo " Events: ${BENCHMARK_EVENTS}" >> "${output_file}"
echo " Workers: ${BENCHMARK_WORKERS}" >> "${output_file}"
echo " Duration: ${BENCHMARK_DURATION}" >> "${output_file}" else
echo "✗ Benchmark failed"
echo "" >> "${output_file}"
echo "RELAY_URL: ${RELAY_URL}" >> "${output_file}"
echo "STATUS: FAILED" >> "${output_file}"
echo "TEST_TIMESTAMP: $(date -Iseconds)" >> "${output_file}"
fi
# Clean up temporary data
rm -rf "${TEMP_DATA_DIR}"
return 0
}
# Main execution
echo "Starting relay benchmark..."
run_benchmark
# Display results
if [ -f "${RUN_DIR}/benchmark_results.txt" ]; then
echo ""
echo "=================================================="
echo "Benchmark Results Summary"
echo "=================================================="
# Extract key metrics from the benchmark report
if grep -q "STATUS: FAILED" "${RUN_DIR}/benchmark_results.txt"; then
echo "Status: FAILED"
grep "ERROR:" "${RUN_DIR}/benchmark_results.txt" | head -1 || echo "Error: Unknown failure"
else
echo "Status: COMPLETED"
# Extract performance metrics
grep "Events/sec:" "${RUN_DIR}/benchmark_results.txt" | head -3 || true
grep "Success Rate:" "${RUN_DIR}/benchmark_results.txt" | head -3 || true
grep "Avg Latency:" "${RUN_DIR}/benchmark_results.txt" | head -3 || true
grep "P95 Latency:" "${RUN_DIR}/benchmark_results.txt" | head -3 || true
grep "Memory:" "${RUN_DIR}/benchmark_results.txt" | head -3 || true
fi
echo ""
echo "Full results available in: ${RUN_DIR}/benchmark_results.txt"
fi
echo ""
echo "=================================================="
echo "Benchmark Completed!"
echo "=================================================="
echo "Results directory: ${RUN_DIR}"
echo "Benchmark finished at: $(date)"