faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-15 19:56:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update performance_testing.md

Browse Source
This commit is contained in:
Alex Ellis 2018-03-01 08:15:43 +00:00 committed by GitHub
parent 62900cf46e
commit e337b0df5b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
guide/performance_testing.md
View File

@ -2,19 +2,34 @@
### Checklist
Performance testing should only be carried out with Kubernetes.
* [ ] I have created a test-plan with a hypothesis and documented my method so I can share it with the project team.
* [ ] I'm using a performance testing tool such as jMeter, LoadRunner or Gattling
* [ ] My environment is hosted in an isolated and repeatable environment
* [ ] I have extended or removed memory limits / quotas
* [ ] I have created my own function and understand the difference between AfterBurn and the default watchdog mode.
* [ ] I have created my own function using one of the new HTTP templates
* [ ] I understand the difference between the original default watchdog which forks one process per request and the new of-watchdog's HTTP mode and I am using that
* [ ] I have turned off `write_debug` and `read_debug` so that the logs for the function are kept sparse
* [ ] I am monitoring / collecting logs from the core services and function under test
* [ ] I am monitoring the system for feedback through Prometheus and / or Grafana - i.e. throughput and 200/500 errors
* [ ] If running on Docker Swarm I've verified that I am using a proper HEALTHCHECK (read up more on watchdog readme)
* [ ] ~~If running on Docker Swarm I've verified that I am using a proper HEALTHCHECK (read up more on watchdog readme)~~
* [ ] I am not using Docker Swarm
* [ ] I am using Kubernetes 1.8 or 1.9
> The [current version of OpenFaaS templates](https://github.com/openfaas/templates) use the original `watchdog` which `forks` processes - a bit like CGI. The newer watchdog [of-watchdog](https://github.com/openfaas-incubator/of-watchdog) is more similar to fastCGI/HTTP and should be used for any benchmarking or performance testing along with one of the newer templates.
of-watchdog templates:
* [Node8 HTTP template](https://github.com/openfaas-incubator/node8-express-template)
* [Golang HTTP template](https://github.com/alexellis/golang-http-template)
### Common mistakes for performance-testing a project:
* Not communicating intent
Communicate your intent to the project so that we can ensure you haven't missed anything and can share results we have obtained during our own testing. Asking arbitary questions out of context will result in a poor interaction with the community and project.
* Using an inappropriate method
There is a differnce between performance testing and Denial of Service DoS attacks. Use tools which allow a gradual ramp-up and controlled conditions such as jMeter, LoadRunner or Gattling.