mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-29 15:37:57 +00:00
Add comprehensive workload harness for end-to-end validation of the
Phases 1-9 telemetry stack:
Task 10.1 — Multi-node test harness:
- docker-compose.workload.yaml with full OTel stack (Collector, Jaeger,
Tempo, Prometheus, Loki, Grafana)
- generate-validator-keys.sh for automated key generation
- xrpld-validator.cfg.template for node configuration
Task 10.2 — RPC load generator:
- rpc_load_generator.py with WebSocket client, configurable rates,
realistic command distribution (40% health, 30% wallet, 15% explorer,
10% tx lookups, 5% DEX), W3C traceparent injection
Task 10.3 — Transaction submitter:
- tx_submitter.py with 10 transaction types (Payment, OfferCreate,
OfferCancel, TrustSet, NFTokenMint, NFTokenCreateOffer, EscrowCreate,
EscrowFinish, AMMCreate, AMMDeposit), auto-funded test accounts
Task 10.4 — Telemetry validation suite:
- validate_telemetry.py checking spans (Jaeger), metrics (Prometheus),
log-trace correlation (Loki), dashboards (Grafana)
- expected_spans.json (17 span types, 22 attributes, 3 hierarchies)
- expected_metrics.json (SpanMetrics, StatsD, Phase 9, dashboards)
Task 10.5 — Performance benchmark suite:
- benchmark.sh for baseline vs telemetry comparison
- collect_system_metrics.sh for CPU/memory/latency sampling
- Thresholds: <3% CPU, <5MB memory, <2ms RPC p99, <5% TPS, <1% consensus
Task 10.6 — CI integration:
- telemetry-validation.yml GitHub Actions workflow
- run-full-validation.sh orchestrator script
- Manual trigger + telemetry branch auto-trigger
Task 10.7 — Documentation:
- workload/README.md with quick start and tool reference
- Updated telemetry-runbook.md with validation and benchmark sections
- Updated 09-data-collection-reference.md with validation inventory
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
151 lines
4.4 KiB
Bash
Executable File
151 lines
4.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# generate-validator-keys.sh — Generate validator key pairs for the workload harness.
|
|
#
|
|
# Uses a temporary standalone xrpld instance to call `validation_create` RPC
|
|
# for each node. Outputs a JSON file mapping node index to seed + public key.
|
|
#
|
|
# Usage:
|
|
# ./generate-validator-keys.sh <xrpld_binary> <num_nodes> <output_dir>
|
|
#
|
|
# Output:
|
|
# <output_dir>/validator-keys.json — JSON array of {index, seed, public_key}
|
|
# <output_dir>/validators.txt — [validators] section for xrpld.cfg
|
|
|
|
set -euo pipefail
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Colored output helpers
|
|
# ---------------------------------------------------------------------------
|
|
log() { printf "\033[1;34m[KEYGEN]\033[0m %s\n" "$*"; }
|
|
ok() { printf "\033[1;32m[KEYGEN]\033[0m %s\n" "$*"; }
|
|
die() { printf "\033[1;31m[KEYGEN]\033[0m %s\n" "$*" >&2; exit 1; }
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Argument parsing
|
|
# ---------------------------------------------------------------------------
|
|
usage() {
|
|
echo "Usage: $0 <xrpld_binary> <num_nodes> <output_dir>"
|
|
echo ""
|
|
echo "Arguments:"
|
|
echo " xrpld_binary Path to xrpld binary (built with telemetry=ON)"
|
|
echo " num_nodes Number of validator key pairs to generate (1-20)"
|
|
echo " output_dir Directory to write validator-keys.json and validators.txt"
|
|
exit 1
|
|
}
|
|
|
|
if [ $# -lt 3 ]; then
|
|
usage
|
|
fi
|
|
|
|
XRPLD="$1"
|
|
NUM_NODES="$2"
|
|
OUTPUT_DIR="$3"
|
|
|
|
# Validate arguments
|
|
[ -x "$XRPLD" ] || die "xrpld binary not found or not executable: $XRPLD"
|
|
[[ "$NUM_NODES" =~ ^[0-9]+$ ]] || die "num_nodes must be a positive integer"
|
|
[ "$NUM_NODES" -ge 1 ] && [ "$NUM_NODES" -le 20 ] || die "num_nodes must be between 1 and 20"
|
|
|
|
mkdir -p "$OUTPUT_DIR"
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Start a temporary standalone xrpld for key generation
|
|
# ---------------------------------------------------------------------------
|
|
TEMP_DIR="$(mktemp -d)"
|
|
TEMP_PORT=5099
|
|
TEMP_CFG="$TEMP_DIR/xrpld.cfg"
|
|
|
|
log "Starting temporary xrpld for key generation (port $TEMP_PORT)..."
|
|
|
|
cat > "$TEMP_CFG" <<EOCFG
|
|
[server]
|
|
port_rpc_keygen
|
|
|
|
[port_rpc_keygen]
|
|
port = $TEMP_PORT
|
|
ip = 127.0.0.1
|
|
admin = 127.0.0.1
|
|
protocol = http
|
|
|
|
[node_db]
|
|
type=NuDB
|
|
path=$TEMP_DIR/nudb
|
|
online_delete=256
|
|
|
|
[database_path]
|
|
$TEMP_DIR/db
|
|
|
|
[debug_logfile]
|
|
$TEMP_DIR/debug.log
|
|
|
|
[ssl_verify]
|
|
0
|
|
EOCFG
|
|
|
|
"$XRPLD" --conf "$TEMP_CFG" -a --start > "$TEMP_DIR/stdout.log" 2>&1 &
|
|
TEMP_PID=$!
|
|
|
|
# Ensure cleanup on exit
|
|
cleanup_temp() {
|
|
kill "$TEMP_PID" 2>/dev/null || true
|
|
wait "$TEMP_PID" 2>/dev/null || true
|
|
rm -rf "$TEMP_DIR"
|
|
}
|
|
trap cleanup_temp EXIT
|
|
|
|
# Wait for RPC to become available
|
|
for attempt in $(seq 1 30); do
|
|
if curl -sf "http://localhost:$TEMP_PORT" \
|
|
-d '{"method":"server_info"}' >/dev/null 2>&1; then
|
|
log "Temporary xrpld RPC ready (attempt $attempt)."
|
|
break
|
|
fi
|
|
if [ "$attempt" -eq 30 ]; then
|
|
die "Temporary xrpld RPC not ready after 30s"
|
|
fi
|
|
sleep 1
|
|
done
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Generate key pairs
|
|
# ---------------------------------------------------------------------------
|
|
log "Generating $NUM_NODES validator key pairs..."
|
|
|
|
KEYS_JSON="["
|
|
VALIDATORS_TXT="[validators]"
|
|
|
|
for i in $(seq 1 "$NUM_NODES"); do
|
|
result=$(curl -sf "http://localhost:$TEMP_PORT" \
|
|
-d '{"method":"validation_create"}')
|
|
seed=$(echo "$result" | jq -r '.result.validation_seed')
|
|
pubkey=$(echo "$result" | jq -r '.result.validation_public_key')
|
|
|
|
if [ -z "$seed" ] || [ "$seed" = "null" ]; then
|
|
die "Failed to generate key pair for node $i"
|
|
fi
|
|
|
|
log " Node $i: ${pubkey:0:20}..."
|
|
|
|
# Build JSON entry
|
|
entry="{\"index\": $i, \"seed\": \"$seed\", \"public_key\": \"$pubkey\"}"
|
|
if [ "$i" -gt 1 ]; then
|
|
KEYS_JSON="$KEYS_JSON,"
|
|
fi
|
|
KEYS_JSON="$KEYS_JSON$entry"
|
|
|
|
VALIDATORS_TXT="$VALIDATORS_TXT
|
|
$pubkey"
|
|
done
|
|
|
|
KEYS_JSON="$KEYS_JSON]"
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Write output files
|
|
# ---------------------------------------------------------------------------
|
|
echo "$KEYS_JSON" | jq '.' > "$OUTPUT_DIR/validator-keys.json"
|
|
echo "$VALIDATORS_TXT" > "$OUTPUT_DIR/validators.txt"
|
|
|
|
ok "Generated $NUM_NODES key pairs:"
|
|
ok " Keys: $OUTPUT_DIR/validator-keys.json"
|
|
ok " Validators: $OUTPUT_DIR/validators.txt"
|