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.

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

Development: Add documentation for benchmarking tool #8047

Merged
merged 6 commits into from
Mar 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions docs/admin/benchmarking-tool.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Benchmarking Tool
=================

The Artemis Benchmarking Tool is a web application designed for Artemis administrators to test the performance of Artemis under heavy load.
It is available on `GitHub <https://github.com/ls1intum/Artemis-Benchmarking>`_.

The Benchmarking Tool for Artemis is designed to simulate realistic user interactions with the Artemis platform,
particularly focusing on exam conduction where the system's performance and scalability are most critical.

This tool enables system administrators and developers to assess and analyze Artemis's behavior under simulated load conditions,
providing valuable insights into response times, system workload, and overall stability.
These insights can be used to identify the limits of the hardware infrastructure as well as the software architecture,
thereby allowing for targeted optimizations and improvements.
The main goal is to ensure that the respective Artemis setup can handle the expected load during exams without any performance issues.

During an exam simulation, the tool participates in the exam on behalf of a configurable number of students.
It performs various actions, such as logging in, starting the exam, submitting answers, and git operations.
For each action, the tool measures the time it takes to complete the action and records the result.
Additionally, the tool can be connected to Prometheus to collect and visualize workload metrics.

For more information on how to set up and use the Benchmarking Tool, please refer to the `README <https://github.com/ls1intum/Artemis-Benchmarking?tab=readme-ov-file#artemis-benchmarking-tool>`_.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ All these exercises are supposed to be run either live in the lecture with insta
admin/troubleshooting
admin/database
admin/knownIssues
admin/benchmarking-tool


.. toctree::
Expand Down
Loading