Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add benchmarking section in contribution page #3709

Merged
merged 4 commits into from
Jul 3, 2024
Merged

doc: add benchmarking section in contribution page #3709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d60652
add benchmark report to doc site
shawnh2 Jun 30, 2024
8b4c9da
update benchmark run in contribution page
shawnh2 Jul 2, 2024
d369920
rename benchmark report
shawnh2 Jul 2, 2024
3e22218
Merge branch 'main' of github.com:envoyproxy/gateway into benchmark-p…
shawnh2 Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions site/content/en/contributions/DEVELOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,34 @@ verify signature was copied to [JWK Creator][] for generating the JWK. The JWK C
settings, i.e. `Signing` public key use and the `RS256` algorithm. The generated JWK was wrapped in a JWKS structure
and is hosted in the repo.

### Benchmarking

Envoy Gateway uses [nighthawk][nighthawk] for benchmarking, and mainly concerned with
its performance and scalability as a control-plane.

The performance and scalability concerns come from several aspects for control-plane:

- The consumption of memory and CPU.
- The rate of configuration changes.

The benchmark test is running on [Kind][Kind] cluster, you can run the following command
to start a Kind cluster and run benchmark test on it.

```shell
make benchmark-test
```

By default, a benchmark report will be generated under `test/benchmark` after test finished.

#### Brief benchmark report

You can browse the detailed benchmark report in `test/benchmark/benchmark-report.md`.

Here are some brief benchmark reports about Envoy Gateway:

- It will take up nearly 1.3GiB memory and 11s total CPU time for (1 GatewayClass + 1 Gateway + 500 HTTRoutes) settings


[Quickstart]: https://github.com/envoyproxy/gateway/blob/main/docs/latest/user/quickstart.md
[make]: https://www.gnu.org/software/make/
[Github Actions]: https://docs.github.com/en/actions
Expand All @@ -161,3 +189,4 @@ and is hosted in the repo.
[request authentication]: ../latest/tasks/security/jwt-authentication
[JWT Debugger]: https://jwt.io/
[JWK Creator]: https://russelldavies.github.io/jwk-creator/
[nighthawk]: https://github.com/envoyproxy/nighthawk
Loading
Loading