Skip to content

Adding API gateway 1.2.0 performance test results - #432

Open
Milanka00 wants to merge 1 commit into
wso2:mainfrom
Milanka00:main
Open

Adding API gateway 1.2.0 performance test results#432
Milanka00 wants to merge 1 commit into
wso2:mainfrom
Milanka00:main

Conversation

@Milanka00

Copy link
Copy Markdown
Contributor

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

  • Verified that llms.txt (located at en/docs/llms.txt) is updated for AI readiness content.
  • Ensured meaningful alt text for images and that the information contained in an image also appears in text so the relevant info exists in the body of the document.
  • Added or updated frontmatter for the respective pages.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review available on request

  • 🔍 Trigger review

Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment @coderabbitai review to review the latest changes. For a full review, comment @coderabbitai full review.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 38537c1d-c6a3-4887-a042-48b11d111553

📝 Walkthrough

Walkthrough

The 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.

Changes

Performance documentation

Layer / File(s) Summary
Overview methodology and deployment
en/docs/api-gateway/{1.2.0,next}/performance/overview.md
The overview pages document EKS and EC2 component placement, revised test dimensions, gateway resource allocations, and router concurrency of 3 for the four-CPU scenario.
Two-CPU benchmark results
en/docs/api-gateway/{1.2.0,next}/performance/gateway-runtime-with-two-cpus.md
The two-CPU pages document EKS pod deployment, set GOMAXPROCS to 1, use versioned charts for 100, 500, and 1000 users, and remove varying-payload results.
Four-CPU benchmark results
en/docs/api-gateway/{1.2.0,next}/performance/gateway-runtime-with-four-cpus.md
The four-CPU pages document EKS pod deployment, set router concurrency to 3 and GOMAXPROCS to 1, and use versioned charts for 100, 500, and 1000 users.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

  • wso2/docs-api-platform#415: Both PRs modify the API Gateway 1.2.0 performance documentation and related runtime benchmark pages.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the purpose and checklist but omits most required sections, including goals, approach, release note, testing, security, and environment details. Complete the required template sections and mark each checklist item with the relevant verification status or explanation.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding API Gateway v1.2.0 performance test results.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0c4fdbb and 25fb578.

⛔ Files ignored due to path filters (9)
  • en/docs/assets/img/api-gateway/performance/1.2.0/deployment-used-for-test.png is excluded by !**/*.png
  • en/docs/assets/img/api-gateway/performance/1.2.0/four-core-AP- with-8-routes-Response-Time-vs-Concurrent-Users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/four-core-API-with-8-routes-Mediation-Policy-Response-Time-vs-Concurrent-Users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/four-core-Average-Response-Time-vs-Concurrent-Users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/four-core-Throughput-vs-Concurrent-Users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/two-core-API-with-8-routes-Mediation-policy-Percentile-Response-Time-vs-Concurrent-Users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/two-core-api-with-8-routes-Percentile-Response-Time-vs-Concurrent-Users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/two-core-average-response-time-vs-concurrent-users.svg is excluded by !**/*.svg
  • en/docs/assets/img/api-gateway/performance/1.2.0/two-core-throughput-vs-concurrent-users.svg is excluded by !**/*.svg
📒 Files selected for processing (6)
  • en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-four-cpus.md
  • en/docs/api-gateway/1.2.0/performance/gateway-runtime-with-two-cpus.md
  • en/docs/api-gateway/1.2.0/performance/overview.md
  • en/docs/api-gateway/next/performance/gateway-runtime-with-four-cpus.md
  • en/docs/api-gateway/next/performance/gateway-runtime-with-two-cpus.md
  • en/docs/api-gateway/next/performance/overview.md

Comment thread en/docs/api-gateway/1.2.0/performance/overview.md
Comment thread en/docs/api-gateway/1.2.0/performance/overview.md
Comment thread en/docs/api-gateway/1.2.0/performance/overview.md
Comment thread en/docs/api-gateway/1.2.0/performance/overview.md
Comment thread en/docs/api-gateway/1.2.0/performance/overview.md
Comment thread en/docs/api-gateway/next/performance/overview.md
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.

1 participant