Development: Add documentation for benchmarking tool

[valentin-boehm]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

The main documentation of the Benchmarking Tool is available in its README. To make sure that Artemis admins find the tool, I added a short section about it to the Artemis docs. The goal of this section is simply to give a short overview about the tool and then link to its Readme for more information.

Description

I added a section called "Benchmarking Tool" to the Administration Guide. It gives a short summary about the tool's core functionality and then links to the repo.

Steps for Testing

Take a look at the new section in the docs: https://artemis-platform--8047.org.readthedocs.build/en/8047/admin/benchmarking-tool.html

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

• Documentation
  • Updated the documentation with a new entry for the Artemis Benchmarking Tool, a web application for administrators to assess system performance under heavy loads and optimize Artemis for exam scenarios.
  • Added a new entry admin/benchmarking-tool to the list of exercises in the documentation.

[coderabbitai]

Walkthrough

The documentation now features the Artemis Benchmarking Tool, designed for testing Artemis under heavy load with a focus on exam scenarios. This tool assesses performance and scalability by simulating user interactions, offering optimization insights. Additionally, a reference to the tool has been included in the documentation index for easy access.

Changes

File Path	Change Summary
docs/admin/.../benchmarking-tool.rst	Introduced the Artemis Benchmarking Tool, outlining its purpose, features, and usage for evaluating system performance under exam load conditions.
docs/index.rst	Added a new entry admin/benchmarking-tool to the documentation index, providing a direct link to the benchmarking tool guide.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[georgyia]

well-written! lgtm

[nata-81]

The documentation explains the benchmarking process well. I ran the text through a language tool and checked it with Grammarly, and there were some minor mistakes. You can decide which ones you want to correct.

This is the corrected text:
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.

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

[Predixx]

Grammar wise it is well written and for me it's understandable. LGTM!

[nata-81]

Re approve

[AntonGeTUM]

Documentation lgtm