EDUCATIC
/
digitaldemocratic
mirror of https://gitlab.com/digitaldemocratic/digitaldemocratic
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
digitaldemocratic/stress-tests/README.md

62 lines
2.3 KiB
Markdown
Raw Normal View History

[stress-tests] Documentation + necessary files to perform testing By executing tests in this normalised fashion it is easier to compare results between different instances or different patch levels. Roughly speaking there are two kinds of tests: - VM tests: which summarise general performance of the instance, without taking DD into account - DD tests: which simulates many logins and interactions with DD, while recording the session as a user would pereceive it from a browser By using these we should be able to consistently compare and improve performance. The original dd-stress-test.tpl.jmx tests file was prepared by Teradisk with hardcoded instance, threadcount and duration values. Testing should now be performed with `vm-test.sh` and `dd-test.sh` respectively, and the template file should stay generic.
2023-02-27 19:38:41 +01:00
# Stress tests
By executing tests in this normalised fashion it is easier to compare results
between different instances or different patch levels.
This documents normalised stress-testing and references files under
[`stress-tests`][st].
[st]: https://gitlab.com/DD-workspace/DD/-/tree/main/stress-tests
## VM tests
[docs] Fix links in stress-test docs
2023-03-01 23:22:10 +01:00
- [`vm-tests.sh`][vm-tests.sh]: generate a text file to compare CPU and other
[stress-tests] Fix typo when finding sysbench binary We were erroneously looking for the sysbench2 binary. While there unify naming and add direct links from the documentation to each mentioned file.
2023-02-28 16:00:26 +01:00
factors across VM types, providers or instances which may affect DD
performance.
[stress-tests] Documentation + necessary files to perform testing By executing tests in this normalised fashion it is easier to compare results between different instances or different patch levels. Roughly speaking there are two kinds of tests: - VM tests: which summarise general performance of the instance, without taking DD into account - DD tests: which simulates many logins and interactions with DD, while recording the session as a user would pereceive it from a browser By using these we should be able to consistently compare and improve performance. The original dd-stress-test.tpl.jmx tests file was prepared by Teradisk with hardcoded instance, threadcount and duration values. Testing should now be performed with `vm-test.sh` and `dd-test.sh` respectively, and the template file should stay generic.
2023-02-27 19:38:41 +01:00
[stress-tests] Fix typo when finding sysbench binary We were erroneously looking for the sysbench2 binary. While there unify naming and add direct links from the documentation to each mentioned file.
2023-02-28 16:00:26 +01:00
We can compare the resulting logs just with, e.g. `vim -d`.
[stress-tests] Documentation + necessary files to perform testing By executing tests in this normalised fashion it is easier to compare results between different instances or different patch levels. Roughly speaking there are two kinds of tests: - VM tests: which summarise general performance of the instance, without taking DD into account - DD tests: which simulates many logins and interactions with DD, while recording the session as a user would pereceive it from a browser By using these we should be able to consistently compare and improve performance. The original dd-stress-test.tpl.jmx tests file was prepared by Teradisk with hardcoded instance, threadcount and duration values. Testing should now be performed with `vm-test.sh` and `dd-test.sh` respectively, and the template file should stay generic.
2023-02-27 19:38:41 +01:00
[stress-tests] Fix typo when finding sysbench binary We were erroneously looking for the sysbench2 binary. While there unify naming and add direct links from the documentation to each mentioned file.
2023-02-28 16:00:26 +01:00
[vm-tests.sh]: https://gitlab.com/DD-workspace/DD/-/tree/main/stress-tests/vm-tests.sh
[stress-tests] Documentation + necessary files to perform testing By executing tests in this normalised fashion it is easier to compare results between different instances or different patch levels. Roughly speaking there are two kinds of tests: - VM tests: which summarise general performance of the instance, without taking DD into account - DD tests: which simulates many logins and interactions with DD, while recording the session as a user would pereceive it from a browser By using these we should be able to consistently compare and improve performance. The original dd-stress-test.tpl.jmx tests file was prepared by Teradisk with hardcoded instance, threadcount and duration values. Testing should now be performed with `vm-test.sh` and `dd-test.sh` respectively, and the template file should stay generic.
2023-02-27 19:38:41 +01:00
## DD tests
Currently these tests perform logins and interact with Nextcloud, but it would
be interesting to expand them to interact with other services.
### Directory contents
This directory contains following files:
[docs] Fix links in stress-test docs
2023-03-01 23:22:10 +01:00
- [`dd-stress-test.tpl.jmx`][dd-stress-test.tpl.jmx]: template to generate
[stress-tests] Fix typo when finding sysbench binary We were erroneously looking for the sysbench2 binary. While there unify naming and add direct links from the documentation to each mentioned file.
2023-02-28 16:00:26 +01:00
[JMeter][jm] tests to execute
[docs] Fix links in stress-test docs
2023-03-01 23:22:10 +01:00
- [`dd-tests.sh`][dd-tests.sh]: helper script that generates the actual test
[stress-tests] Fix typo when finding sysbench binary We were erroneously looking for the sysbench2 binary. While there unify naming and add direct links from the documentation to each mentioned file.
2023-02-28 16:00:26 +01:00
plan files and executes them. See `./dd-tests.sh --help`
[docs] Fix links in stress-test docs
2023-03-01 23:22:10 +01:00
- [`dd-tests-selenium.py`][dd-tests-selenium.py]: this gives us an idea of
[stress-tests] Fix typo when finding sysbench binary We were erroneously looking for the sysbench2 binary. While there unify naming and add direct links from the documentation to each mentioned file.
2023-02-28 16:00:26 +01:00
how a user would perceive DD to be behaving while under load.
Called by `./dd-tests.sh` by default.
[dd-stress-test.tpl.jmx]: https://gitlab.com/DD-workspace/DD/-/tree/main/stress-tests/dd-stress-test.tpl.jmx
[dd-tests.sh]: https://gitlab.com/DD-workspace/DD/-/tree/main/stress-tests/dd-tests.sh
[dd-tests-selenium.py]: https://gitlab.com/DD-workspace/DD/-/tree/main/stress-tests/dd-tests-selenium.py
[stress-tests] Documentation + necessary files to perform testing By executing tests in this normalised fashion it is easier to compare results between different instances or different patch levels. Roughly speaking there are two kinds of tests: - VM tests: which summarise general performance of the instance, without taking DD into account - DD tests: which simulates many logins and interactions with DD, while recording the session as a user would pereceive it from a browser By using these we should be able to consistently compare and improve performance. The original dd-stress-test.tpl.jmx tests file was prepared by Teradisk with hardcoded instance, threadcount and duration values. Testing should now be performed with `vm-test.sh` and `dd-test.sh` respectively, and the template file should stay generic.
2023-02-27 19:38:41 +01:00
### Results
Results will be saved in a `results` directory, where each subdirectory
corresponds to a stress test executed with `dd-test.sh`.
The naming scheme for those subdirectories is: `DOMAIN_THREADCOUNT_DURATION`
Where `THREADCOUNT` and `DURATION` are the corresponding [JMeter][jm]
parameters.
Each results directory contains:
- `log`: the [JMeter][jm] log
- `results`: the [JMeter][jm] results file
- `html/index.html`: the interactive graphs for the data as produced by JMeter
- `selenium/session.html`: the session report as would be perceived by a user.
Note this requires Python3 and selenium and can be disabled by setting the
environment variable: `USE_SELENIUM=NO`.
[jm]: https://jmeter.apache.org/