Adding API gateway 1.2.0 performance test results - #432
Conversation
|
Important Review available on request
Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📝 WalkthroughWalkthroughThe performance documentation now describes Amazon EKS deployment, revised concurrency and runtime settings, updated benchmark datasets, and versioned chart assets for two-CPU and four-CPU scenarios. ChangesPerformance documentation
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 10
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-four-cpus.md`:
- Line 52: Update the benchmark artifact references in this page so all linked
assets use the 1.2.0 dataset: add the missing /1.2.0/ segment to the
mediation-policy percentile image link and change the CSV link from
api-gateway-1.1.0-perf-test-results to its matching 1.2.0 artifact.
In `@en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-two-cpus.md`:
- Line 25: Replace “requests/sec” with “requests per second” in the throughput
headings at
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-two-cpus.md:25-25,
en/docs/api-gateway/next/performance/gateway-runtime-with-two-cpus.md:25-25,
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-four-cpus.md:25-25,
and
en/docs/api-gateway/next/performance/gateway-runtime-with-four-cpus.md:25-25.
- Line 50: Keep all benchmark artifacts aligned with the 1.2.0 dataset. In
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-two-cpus.md (Line 50
anchor), en/docs/api-gateway/next/performance/gateway-runtime-with-two-cpus.md
(Line 50 sibling),
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-four-cpus.md (Line 52
sibling), and
en/docs/api-gateway/next/performance/gateway-runtime-with-four-cpus.md (Line 52
sibling), update the CSV links to target the 1.2.0 result set; additionally add
/1.2.0/ to the mediation-policy percentile asset links in both four-CPU pages.
In `@en/docs/api-gateway/1.2.0/performance/overview.md`:
- Line 3: Update the frontmatter description in
en/docs/api-gateway/1.2.0/performance/overview.md at lines 3-3 and
en/docs/api-gateway/next/performance/overview.md at lines 3-3 with the same
shortened description, keeping it under 158 characters and expanding Amazon
Elastic Kubernetes Service (EKS) at first use.
- Line 23: Update the Results paragraph in both
en/docs/api-gateway/1.2.0/performance/overview.md:23-23 and
en/docs/api-gateway/next/performance/overview.md:23-23 to describe tests with
100, 500, and 1000 concurrent users across two gateway configurations, removing
the outdated payload-size and two-concurrency-level descriptions.
- Line 36: Replace positional “below” image references in
en/docs/api-gateway/1.2.0/performance/overview.md:36 and
en/docs/api-gateway/next/performance/overview.md:36 with “The deployment diagram
shows...”. In
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-two-cpus.md:27,
en/docs/api-gateway/next/performance/gateway-runtime-with-two-cpus.md:27,
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-four-cpus.md:27, and
en/docs/api-gateway/next/performance/gateway-runtime-with-four-cpus.md:27, use
“The throughput chart shows...” instead.
- Line 18: Rewrite the performance methodology in active voice with short,
direct sentences. Update the referenced passages around the API evaluation, test
execution, configuration, deployment, and documentation so each states the
responsible actor, removes filler such as “As the name suggests,” and keeps each
sentence within 26 words.
- Line 38: Update every listed image in
en/docs/api-gateway/1.2.0/performance/overview.md:38-38,
en/docs/api-gateway/next/performance/overview.md:38-38, both
gateway-runtime-with-two-cpus.md files at lines 29-29, 40-40, and 50-50, and
both gateway-runtime-with-four-cpus.md files at lines 29-29, 41-41, and 52-52.
Shorten each alt text to 155 characters or fewer while preserving its subject,
and add the required 1x/2x srcset to every image.
In `@en/docs/api-gateway/next/performance/gateway-runtime-with-four-cpus.md`:
- Line 52: Update the benchmark artifact links in this performance report,
including the mediation-policy percentile image and the CSV link, to use the
matching 1.2.0 dataset. Preserve the existing link targets and formatting while
replacing the omitted or outdated 1.1.0 artifact references.
In `@en/docs/api-gateway/next/performance/overview.md`:
- Line 18: Rewrite the updated methodology in
en/docs/api-gateway/next/performance/overview.md using active voice, short
sentences, and explicit actors. Update the text at the referenced sections,
including the sentence around “The performance of the WSO2 API Platform
Gateway,” to remove passive constructions, split sentences exceeding 26 words,
and remove filler such as “As the name suggests.”
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 270b2abf-c230-48a5-ae61-8849570f20b2
⛔ Files ignored due to path filters (9)
en/docs/assets/img/api-gateway/performance/1.2.0/deployment-used-for-test.pngis excluded by!**/*.pngen/docs/assets/img/api-gateway/performance/1.2.0/four-core-AP- with-8-routes-Response-Time-vs-Concurrent-Users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/four-core-API-with-8-routes-Mediation-Policy-Response-Time-vs-Concurrent-Users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/four-core-Average-Response-Time-vs-Concurrent-Users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/four-core-Throughput-vs-Concurrent-Users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/two-core-API-with-8-routes-Mediation-policy-Percentile-Response-Time-vs-Concurrent-Users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/two-core-api-with-8-routes-Percentile-Response-Time-vs-Concurrent-Users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/two-core-average-response-time-vs-concurrent-users.svgis excluded by!**/*.svgen/docs/assets/img/api-gateway/performance/1.2.0/two-core-throughput-vs-concurrent-users.svgis excluded by!**/*.svg
📒 Files selected for processing (6)
en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-four-cpus.mden/docs/api-gateway/1.2.0/performance/gateway-runtime-with-two-cpus.mden/docs/api-gateway/1.2.0/performance/overview.mden/docs/api-gateway/next/performance/gateway-runtime-with-four-cpus.mden/docs/api-gateway/next/performance/gateway-runtime-with-two-cpus.mden/docs/api-gateway/next/performance/overview.md
Purpose
This PR adds the performance test results for API Platform Gateway v1.2.0 from a Kubernetes deployment provisioned on AWS EKS.
The results are presented using the same reporting approach as the previous performance reports, with the charts updated to reflect the latest benchmark results.
Checklist
llms.txt(located aten/docs/llms.txt) is updated for AI readiness content.