Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Load testing Moodle with JMeter: Difference between revisions

From MoodleDocs
No edit summary
mNo edit summary
 
(31 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Being the original load testing tool for servers, introduced in 1998(!), JMeter [http://jmeter.apache.org/] has always been the number one load testing resp. performance measuring tool for Moodle. Around its release 2.5, Moodle developers made the testing process vastly simpler by adding many scripts. The topic of this page is the usage of the two scripts ''Make test course'' [https://docs.moodle.org/en/Test_course_generator] and ''Make JMeter test plan'' [https://docs.moodle.org/en/JMeter_test_plan_generator] and JMeter running on a client machine.


This article is a stub until we collect enough information about the developments since [https://docs.moodle.org/dev/index.php?title=JMeter&oldid=35771 previous update in 2012]. All improvements are welcome!
Warning:  Do not run these scripts nor JMeter targeting a production system! They generate a large amounts of artificial data and load the server to its limit and beyond, making it to bloat and/or become non-responsive. Don't even run them on a separate Moodle instance in the production server: their effect on the DBMS is undocumented.


You can also add your comments to the [https://docs.moodle.org/dev/index.php?title=Talk:JMeter&action=edit&redlink=1 discussion page] or to the the [https://moodle.org/mod/forum/discuss.php?d=395002 discussion in the General developer forum].
<h2>Prerequisite</h2>
<h3>JMeter installed on your client computer</h3>
JMeter is a Java application so it can run on Windows, Mac, or Linux. It can be run on the command line or on its graphical client on your desktop. First check if Java is installed in your client computer by opening a console and entering 'java -version'. If it doesn't return a version, first install [https://www.java.com/ Java] on your client. The instructions vary with the operating system.


<hr/ >
To install JMeter go to the [http://jmeter.apache.org/download_jmeter.cgi JMeter page], download the zip and unzip it to the directory of your choice.
The Apace JMeter has always been the most common load testing resp. performance measurement tool for Moodle. Since release 2.5, Moodle makes the process vastly simpler through two built-in scripts '''Make test course''' (Site administration > Development > Make test course) and '''Make JMeter test plan''' (Site administration > Development > Make JMeter test plan) augmented by the add-ons [https://github.com/moodlehq/moodle-performance-comparison Moodle performance comparison]. This document is about the two built-in scripts.


Warning:  '''Do not run these scripts on a production system!'''
<h2>A test plan</h3>
You can make a test plan from the JMeter client in DIY style. We do not describe that path here, assuming you know JMeter. This page describes how to make a test plan with the scripts built in to Moodle and run it.


These tests load the server to its limits and beyond, making it nonreponsive. Even if you can afford down-times don't run them on a separate Moodle instance on the production server: their effect on the DBMS is undocumented.
<h3>Make test course</h3>
See https://docs.moodle.org/en/Test_course_generator


<h2>Make test course</h2>
<h3>Make JMeter test plan</h3>
(to be filled)
See https://docs.moodle.org/en/JMeter_test_plan_generator


<h2>Make JMeter test plan</h2>
<h2>Running the test plan on JMeter</h2>
(to be filled)
To run JMeter open the /bin subdirectory and use either jmeter.bat on Windows or ./jmeter on Linux. This will open the JMeter GUI.


<h2>Running the test plan on JMeter</h2>
First step is to go to File -> Open and select the testplan.jmx file you downloaded above. 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. <b>Repeat </b> this for Moodle Test.
(to be filled)


Right mouse click on the Test Plan, then Add -> Listener. Choose Aggregate Report so you can follow the run as it happens. Save the changes in your test plan and run it.


==See also==
==References==
*[http://jmeter.apache.org/jmeter/ Apache JMeter homepage]
* [1] [http://jmeter.apache.org/ Apache JMeter homepage]
* [2] [https://docs.moodle.org/en/Performance_recommendations#Obtain_a_baseline_benchmark Moodle Docs: Performance -> Obtain_a_baseline_benchmark]
* [3] [https://moodle.org/mod/forum/discuss.php?d=377231 Jmeter or loading script/app to simulate concurrent users taking quizzes] (October 2018)
* [4]  [https://moodle.org/mod/forum/discuss.php?d=368620 Has anyone successfully run a jmeter test with 1000 users?] (April 2018)


[[Category:Developer tools]]
[[Category:Developer tools]]

Latest revision as of 17:55, 7 January 2022

Being the original load testing tool for servers, introduced in 1998(!), JMeter [1] has always been the number one load testing resp. performance measuring tool for Moodle. Around its release 2.5, Moodle developers made the testing process vastly simpler by adding many scripts. The topic of this page is the usage of the two scripts Make test course [2] and Make JMeter test plan [3] and JMeter running on a client machine.

Warning: Do not run these scripts nor JMeter targeting a production system! They generate a large amounts of artificial data and load the server to its limit and beyond, making it to bloat and/or become non-responsive. Don't even run them on a separate Moodle instance in the production server: their effect on the DBMS is undocumented.

Prerequisite

JMeter installed on your client computer

JMeter is a Java application so it can run on Windows, Mac, or Linux. It can be run on the command line or on its graphical client on your desktop. First check if Java is installed in your client computer by opening a console and entering 'java -version'. If it doesn't return a version, first install Java on your client. The instructions vary with the operating system.

To install JMeter go to the JMeter page, download the zip and unzip it to the directory of your choice.

A test plan

You can make a test plan from the JMeter client in DIY style. We do not describe that path here, assuming you know JMeter. This page describes how to make a test plan with the scripts built in to Moodle and run it.

Make test course

See https://docs.moodle.org/en/Test_course_generator

Make JMeter test plan

See https://docs.moodle.org/en/JMeter_test_plan_generator

Running the test plan on JMeter

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 you downloaded above. 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. Choose Aggregate Report so you can follow the run as it happens. Save the changes in your test plan and run it.

References