docs: surface JMH benchmark results in README + docs site#12
Merged
Conversation
Adds a "Performance" section to both READMEs (en/ko) and a new
guides/performance{,.ko}.md page on the mkdocs site, surfacing the
numbers captured in BENCHMARKS.md. Without this, the canonical
"what does ssrf-guard cost?" answer was buried in a repo-root file
that consumers never browse — now it appears one scroll into the
README and as a dedicated docs-site page.
The headline number is the allowed-path interceptor cost:
**~5 μs per request** on JDK 21, which is 0.005% overhead on a
100 ms remote API call. Each table includes the per-case score +
stdev from the JMH run, with a "how to read" guide so consumers
don't compare benchmarks they shouldn't.
Files:
- README.md / README.ko.md: new "Performance" / "성능" section
inserted between Observability and the auto-config section.
Five-row table + link to BENCHMARKS.md and the gradle task to
reproduce locally.
- docs/guides/performance.md / .ko.md: full standalone page —
what's measured, results tables, practical takeaway with
latency-vs-overhead matrix, how-to-read, what's deliberately
out of scope (DNS-time gates, startup cost, GraalVM AOT).
Links to BENCHMARKS.md for canonical methodology + new-benchmark
contribution guide.
- mkdocs.yml: Performance entry added to the Guides section in nav
+ 성능 translation under the ko locale's nav_translations.
Verified locally with `mkdocs build --strict` — no new warnings
introduced (pre-existing anchor-link warnings in installation.md /
configuration.ko.md untouched).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Surfaces the JMH numbers from #11's
BENCHMARKS.mdinto the two places consumers actually look:BENCHMARKS.md.The headline number that lands on the README:
What changes
README.mdREADME.ko.mddocs/guides/performance.mddocs/guides/performance.ko.mdmkdocs.ymlVerification
mkdocs build --strict— clean build in 4.32 s, no new warnings (pre-existing anchor-link warnings in installation.md / configuration.ko.md untouched)BENCHMARKS.mdresolves on GitHubRelated
BENCHMARKS.md(canonical source): added in #11 (merged)BENCHMARKS.mdis for contributors / reviewers; this is for consumers evaluating the library