Load testing Moodle with JMeter
This article is a stub until we collect enough information about the developments since previous update in 2012. All improvements are welcome!
You can also add your comments to the discussion page or to the the discussion in the General developer forum.
The Apache JMeter has always been the most common load testing resp. performance measuring tool in the Moodle community. Since around release 2.5, Moodle makes the process of load testing with JMeter vastly simpler through two built-in scripts, ""Make test course and Make JMeter test plan, both under Site administration > Development, augmented by a set of add-ons Moodle performance comparison. This document is about using the two built-in scripts with JMeter.
Warning: Do not run these scripts on a production system! These scripts generate data and load the server to its limit and beyond, making it to bloat and become non-reponsive. Don't even run them on a separate Moodle instance in the production server: their effect on the DBMS is undocumented.
Make test course
This tool creates standard test courses that include many sections, activities, and files. This is intended to provide a standardised measure for checking the reliability and performance of various system components (such as backup and restore). This test is important because there have been many cases previously where, faced with real-life use cases (e.g. a course with 1,000 activities), the system does not work.
Courses created using this feature can occupy a large amount of database and filesystem space (tens of gigabytes). You will need to delete the courses (and wait for various cleanup runs) to release this space again.
Once you have set the debugging level Site administration > Development > Debugging: Debug messages = DEVELOPER: extra Moodle debug messages for developers, visit Site administration > Development > Make test course. You have the choice between XS (~10 KB; create in ~1 second), S (~10 KB, create in ~30 secends), M (~100 KB, create in ~2 minutes), L (~1 GB, create in ~30 minutes), XL (~10 GB, create in ~2 hours) and XXL (~20 GB, created in ~4 hours).
Output:
Creating course Creating [Course name] Creating assignments (100): . . . . . . . . . . . . done (12.7s) Creating pages (200): . . done (1.5s) Creating small files (128): done (0.4s) Creating big files (5): . done (1.3s) Checking user accounts (1000) Creating user accounts (1 - 1000): . . . . . . . . done (8.7s) Enrolling users into course (1000): . . . . . . done (5.7s) Creating forum (500 posts): . . done (1.7s) Course completed (32.2s)
The final Continue will give you a view of the course thus created.
Make JMeter test plan
This tool creates a JMeter test plan file along with the user credentials file.
This test plan is designed to work along with Moodle performance comparison, which makes easier to run the test plan in a specific Moodle environment, gathers information about the runs and compares the results, so you will need to download it and use it's test_runner.sh script or follow the installation and usage instructions.
You need to set a password for the course users in config.php (e.g. $CFG->tool_generator_users_password = 'moodle';). You might want to set $CFG->passwordpolicy = 0; in your config.php if the proposed user password conflicts with the password policy of the site.
There is no default value for this password to prevent unintended usages of the tool. You need to use the update passwords option in case your course users have other passwords or they were generated by tool_generator but without setting a $CFG->tool_generator_users_password value.
It is part of tool_generator so it works well with the courses generated by the courses and the site generators, it can also be used with any course that contains, at least: - Enough enrolled users (depends on the test plan size you select) with the password reset to 'moodle' - A page module instance - A forum module instance with at least one discussion and one reply
You might want to consider your servers capacity when running large test plans as the amount to load generated by JMeter can be specially big. The ramp up period has been adjusted according to the number of threads (users) to reduce this kind of issues but the load is still huge.
Visit Site administration > Development > Make JMeter test plan. Under Size of course your have six possibilities: XS (1 user, 5 loops and 1 rampup period), S (30 users, 5 loops and 6 rampup period), M (100 users, 5 loops and 40 rampup period), L (1000 users, 6 loops and 100 rampup period), XL (5000 users, 6 loops and 500 rampup period) and XXL (1000 users, 7 loops and 800 rampup period). As target course select one of the courses created above. Update course users password: ticked.
Once successful you can download a test plan testplan_timestamp.jmx and a users file users_timestamp.csv
$ php admin/tool/generator/cli/maketestplan.php --help Options: -h, --help Print out this help --shortname Shortname of the test plan's target course (required) --size Size of the test plan to create XS, S, M, L, XL, or XXL (required) --bypasscheck Bypasses the developer-mode check (be careful!) --updateuserspassword Updates the target course users password according to $CFG->tool_generator_users_password * XS (1 Nutzter, 5 Schleifen und 1 Steigerungsrate) * S (30 Nutzter, 5 Schleifen und 6 Steigerungsrate) * M (100 Nutzter, 5 Schleifen und 40 Steigerungsrate) * L (1000 Nutzter, 6 Schleifen und 100 Steigerungsrate) * XL (5000 Nutzter, 6 Schleifen und 500 Steigerungsrate) * XXL (10000 Nutzter, 7 Schleifen und 800 Steigerungsrate) Consider that, the server resources you will need to run the test plan will be higher as the test plan size is higher. Example from Moodle root directory: $ sudo -u www-data /usr/bin/php admin/tool/generator/cli/maketestplan.php --shortname="testcourse_12" --size=S
Running the test plan on JMeter
JMeter is a Java application so it can run on Windows, Mac, or Linux. It can be run on the command line on a server but you should also install a graphical user interface version on your desktop. You can check if Java is installed by opening a console and entering:
java -version
If it doesn't return a version, go to the Java site and install.
To install JMeter go to the JMeter page, download the zip and unzip it to the directory of your choice.
To run JMeter. open the /bin subdirectory and use either jmeter.bat on Windows or ./jmeter on Linux. This will open the JMeter GUI.
First step is to go to File -> Open and select the testplan.jmx file. This will open a tree on the left hand side of JMeter. Open the Warm-up site -> Default site request and enter the protocol (http or https) and Server name or IP. Then go to CSV Users Data and locate your users.csv file under Filename. Repeat this for Moodle Test.
Right mouse click on the Test Plan, then Add -> Listener. I choose Aggregate Report so I can follow the run as it happens. Save the changes in your test plan and run it.
