Skip to content

docs: Add docs/PERF_BASELINE.md with numbers per major release (#716) - #1

Open
Ayomikun2005 wants to merge 4 commits into
mainfrom
docs/perf-baseline-716
Open

docs: Add docs/PERF_BASELINE.md with numbers per major release (#716)#1
Ayomikun2005 wants to merge 4 commits into
mainfrom
docs/perf-baseline-716

Conversation

@Ayomikun2005

Copy link
Copy Markdown
Owner

Closes CredenceOrg#716

Summary

Adds docs/PERF_BASELINE.md establishing performance baseline metrics across major releases of Credence Backend (v0.1.0, v1.0.0, v2.0.0). This document gives operators and reviewers empirical figures to eyeball performance regressions during pre-release benchmarking.

Changes Included

  • New Document (docs/PERF_BASELINE.md):
    • Target audience specified for Operators (SREs & System Administrators).
    • Standardized environment specifications (Node.js runtime, PostgreSQL, Redis hardware profile).
    • Detailed release matrix with throughput (RPS) and latency percentiles (p50, p95, p99) for core endpoints (/api/health/ready, /api/trust/:address, /api/bond/:address, POST /api/attestations, /api/analytics/summary).
    • Executable benchmark commands (autocannon) and runnable Node.js benchmark verification script.
    • Performance regression threshold definitions and operator action plan.
  • Documentation Cross-Linking:
    • Linked from top-level README.md.
    • Linked from docs/SLO.md and docs/sla-metrics.md.

Verification

  • Ran npx tsc --noEmit (type checking clean)
  • Ran npm run sbom:check (SBOM validation clean)
  • Verified cross-links and markdown formatting

@Baskarayelu
Baskarayelu force-pushed the docs/perf-baseline-716 branch from f64bd14 to 63d6aa4 Compare July 24, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a docs/PERF_BASELINE.md with numbers per major release

1 participant