The Jakarta Project

About

Documentation

Community

13.1 Generative Controllers
This controller lets you send an FTP "retrieve file" request to an FTP server. If you are going to send multiple requests to the same FTP server, consider using a Configuration Element so you do not have to enter the same information for each FTP Request Generative Controller. Descriptive name for this controller that is shown in the tree. Domain name or IP address of the FTP server. JMeter assumes the FTP server is listening on the default port. Path and name of the file to retrieve. FTP account username. FTP account password. Assertions Building an FTP Test Plan

This controller lets you send an HTTP/HTTPS request to a web server. It also lets you control whether or not JMeter parses HTML files for images and Java applets and sends HTTP requests to retrieve them.

If you are going to send multiple requests to the same web server, consider using an Configuration Element so you do not have to enter the same information for each HTTP Request controller.

Or, instead of manually adding HTTP Request controllers, you may want to use JMeter's to create them. This can save you time if you have a lot of HTTP requests or requests with many parameters.

If the request requires a login authorization, you will also have to add an Configuration Element. And, if the request uses cookies, then you will also need an . You can add either of these elements to the Thread Group or the HTTP Request. If you have more than one HTTP Request that needs authorizations or cookies, then add the elements to the Thread Group. That way, all HTTP Request controllers will share the same Authorization Manager and Cookie Manager elements.

If the request uses a technique called "URL Rewriting" to maintain sessions, then see section 6.x HTTP Requests and Session ID's: URL Rewriting for additional configuration steps.

Descriptive name for this controller that is shown in the tree. Domain name or IP address of the web server. Port the web server is listening to. HTTP or HTTPS. HTTP GET or HTTP POST. The path to resource (for example, /servlets/myServlet). If the resource requires query string parameters, add them below in the "Send Parameters With the Request" section. The query string will be generated from the list of parameters you provide. Each parameter has a name and value. The query string will be generated in the correct fashion, depending on the choice of "Method" you made (ie if you chose GET, the query string will be appended to the URL, if POST, then it will be sent separately). Also, if you are sending a file using a multipart form, the query string will be created using the multipart form specifications. Name of the file to send. If left blank, JMeter does not send a file, if filled in, JMeter automatically sends the request as a multipart form request. Name of the web request parameter. MIME type (for example, text/plain). Tell JMeter to parse the HTML file and send HTTP/HTTPS requests for all images and Java applets referenced in the file. Assertion Building a Web Test Plan Building an Advanced Web Test Plan HTTP Requests and Session ID's: URL Rewriting

This controller lets you send an JDBC Request (an SQL query) to a database.

If you are going to send multiple requests to the same database, consider using one or more of the Defaults Configuration Elements: , , . This way, you do not have to enter the same information for each JDBC Request controller.

Descriptive name for this controller that is shown in the tree. URL of the database (for example, "jdbc:weblogic:oracle"). Refer to your database's JDBC documentation for the URL you should use. The database driver Java class (for example, "weblogic.jdbc.oci.Driver"). Refer to your database's JDBC documentation for the name of the JDBC driver class you should use. FTP account username. FTP account password. Number of database connection instances to create and keep active. The maximum value depends on your database. Also, JMeter imposes a maximum of 100 connections. Maximum number of times JMeter uses a database connection instance before recycling it (destroying and creating a new instance). SQL query (for example, "select * from t_customers"). Assertion Building a Database Test Plan
13.2 Logic Controllers

If you add Generative or Logic Controllers to an Interleave Controller, JMeter will alternate among each of the other controllers for each loop iteration.

Descriptive name for this controller that is shown in the tree.

Download this example (see Figure 1). In this example, we configured the Thread Group to have two threads and a loop count of five, for a total of ten requests. See the table below for the sequence JMeter sends the HTTP Requests.

Figure 1 - Interleave Controller Example 1
Loop IterationEach JMeter Thread Sends These HTTP Requests
1News Page
2FAQ Page
3Gump Page
4Because there are no more requests in controller, JMeter start over and sends the first HTTP Request, which is the News Page.
5FAQ Page

Note, the File Reporter is configured to store the results in a file named "interleave-test.dat" in the current directory.

Download another example (see Figure 2). In this example, we configured the Thread Group to have a single thread and a loop count of eight. Notice that the Test Plan has an outer Interleave Controller with two Interleave Controllers inside of it.

Figure 2 - Interleave Controller Example 2

The outer Interleave Controller alternates between the two inner ones. Then, each inner Interleave Controller alternates between each of the HTTP Requests. Each JMeter thread will send the requests in the following order: Home Page, Bug Page, CVS Page, and FAQ Page. Note, the File Reporter is configured to store the results in a file named "interleave-test2.dat" in the current directory.

If you add Generative or Logic Controllers to a Loop Controller, JMeter will loop through them a certain number of times, in addition to the loop value you specified for the Thread Group. For example, if you add one HTTP Request to a Loop Controller with a loop count of two, and configure the Thread Group loop count to three, JMeter will send a total of 2 * 3 = 6 HTTP Requests.

Descriptive name for this controller that is shown in the tree. The number of times the subelements of this controller will be iterated each time through a test run.

Special Case: The Loop Controller embedded in the Thread Group element behaves slightly differently. Unless set to forever, it stops the test after the given number of iterations have been done.

Download this example (see Figure 3). In this example, we created a Test Plan that sends a particular HTTP Request only once and sends another HTTP Request five times.

Figure 3 - Loop Controller Example

We configured the Thread Group for a single thread and a loop count value of one. Instead of letting the Thread Group control the looping, we used a Loop Controller. You can see that we added one HTTP Request to the Thread Group and another HTTP Request to a Loop Controller. We configured the Loop Controller with a loop count value of five.

JMeter will send the requests in the following order: Home Page, News Page, News Page, News Page, News Page, and News Page. Note, the File Reporter is configured to store the results in a file named "loop-test.dat" in the current directory.

This element has no visual elements, and needs no configuration. The Modification Manager acts as a container for Modifier elements (which are special kinds of Configuration Elements).

The Modification Manager can be used to introduce dynamic data into a test script. As test samples pass through the Modification Manager, it has the opportunity to modify them. The Modification Manager holds Modifier elements which it uses to control how it modifies test samples. If no Modifier elements are added, the Modification Manager has no effect.

There are two types of Modifiers. Regular Modifiers (currently there aren't any implemented Modifiers), and response based Modifiers (there is one HTML response based Modifier).

The Once Only Logic Controller tells JMeter to process the controller(s) inside it only once, regardless of the loop count value you specify in the Thread Group or Loop Controller.

For testing that requires a login, consider placing the login request in this controller since each thread only needs to login once to establish a session.

Descriptive name for this controller that is shown in the tree.

Download this example (see Figure 4). In this example, we created a Test Plan that has two threads that send HTTP request. Each thread sends one request to the Home Page, followed by three requests to the Bug Page. Although we configured the Thread Group to iterate three times, each JMeter thread only sends one request to the Home Page because this request lives inside a Once Only Controller.

Figure 4. Once Only Controller Example

Each JMeter thread will send the requests in the following order: Home Page, Bug Page, Bug Page, Bug Page. Note, the File Reporter is configured to store the results in a file named "loop-test.dat" in the current directory.

The Simple Logic Controller lets you organize your Generative Controllers and other Logic Controllers. Unlike other Logic Controllers, this controller provides no functionality beyond that of a storage device.

Descriptive name for this controller that is shown in the tree.

Download this example (see Figure 5). In this example, we created a Test Plan that sends two Ant HTTP requests and two Log4J HTTP requests. We grouped the Ant and Log4J requests by placing them inside Simple Logic Controllers. Remember, the Simple Logic Controller has no effect on how JMeter processes the controller(s) you add to it. So, in this example, JMeter sends the requests in the following order: Ant Home Page, Ant News Page, Log4J Home Page, Log4J History Page. Note, the File Reporter is configured to store the results in a file named "simple-test.dat" in the current directory.

Figure 5 Simple Controller Example
13.3 Listeners
No Description No Description

The Graph Results listener generates a simple graph that plots all sample times. Along the right side of the graph, the current sample (black), the current average of all samples(blue), and the current standard deviation (red) are displayed in milliseconds.

The Spline Visualizer provides a view of all sample times from the start of the test till the end, regardless of how many samples have been taken. The spline has 10 points, each representing 10% of the samples, and connected using spline logic to show a single continuous line.

The Assertion Results visualizer shows the URL of each sample taken (no time information is shown). It also reports failures of any Assertions that are part of the test plan.

The File Reporter records sample data to a file. Name of file to save samples to. If yes, then data is appended to the end of the file. If no, then JMeter erases the previous contents of the file when you hit "Open". Normally, the file is not written continuously. If selected, each sample will be written to the file as it comes in. Sample Verbose Output:
# Sample data created by null

#       URL                    Milliseconds

http://jakarta.apache.org/ 1650,
http://jakarta.apache.org/ 1920,
http://jakarta.apache.org/ 1200,
http://jakarta.apache.org/ 1650,
http://jakarta.apache.org/ 1700,
http://jakarta.apache.org/ 1980,
Sample Non-Verbose Output:
4440
4830
6540
5550
3080
3350
This will include all data JMeter sent with the request, beyond the URL (ie POSTed data for web testing, SQL statements for database testing). Until you hit "Open", no sample data will be recorded. Normally, you would do this before starting the test. Sends all data collected to the file. If "Automatically Flush Data After Each Sample" was selected, this is unnecessary. Closes the file, flushing all collected data at the same time.
The View Results visualizer displays the response from the server. No time information is given. Hit the "Next" button to view the next sample response. Consider using the instead. The View Results Tree shows a tree of all sample responses, allowing you to view the response for any sample. In addition to showing the response, you can see the time it took to get this response, and some response codes.
13.4 Configuration Elements

The Authorization Manager lets you specify one or more user logins for web pages that are restricted using Basic HTTP Authentication. You see this type of authentication when you use your browser to access a restricted page, and your browser displays a login dialog box. JMeter transmits the login information when it encounters this type of page.

In the current release, all JMeter threads in a Thread Group use the same username/password for a given Base URL even if you create multiple users with the same Base URL in the authorization table. We plan to correct this in a future release. As a workwaround, you can create multiple Thread Groups for your Test Plan, with each Thread Group having its own Authorization Manager.
Descriptive name for this element that is shown in the tree. A partial or complete URL that matches one or more HTTP Request URLs. As an example, say you specify a Base URL of "http://jakarta.apache.org/restricted/" with a username of "jmeter" and a password of "jmeter". If you send an HTTP request to the URL "http://jakarta.apache.org/restricted/ant/myPage.html", the Authorization Manager sends the login information for the user named, "jmeter". The username to authorize. The password to authorize. Controls:
  • Add Button - Add an entry to the authorization table.
  • Delete Button - Delete the currently selected table entry.
  • Load Button - Load a previously saved authorization table and add the entries to the existing authorization table entries.
  • Save As Button - Save the current authorization table to a file.
When you save the Test Plan, JMeter automatically saves all of the authorization table entries.

Download this example. In this example, we created a Test Plan on a local server that sends three HTTP requests, two requiring a login and the other is open to everyone. See figure 6 to see the makeup of our Test Plan. On our server, we have a restricted directory named, "secret", which contains two files, "index.html" and "index2.html". We created a login id named, "kevin", which has a password of "spot". So, in our Authorization Manager, we created an entry for the restricted directory and a username and password (see figure 7). The two HTTP requests named "SecretPage1" and "SecretPage2" make requests to "/secret/index1.html" and "/secret/index2.html". The other HTTP request, named "NoSecretPage" makes a request to "/index.html".

Figure 6 - Test Plan
Figure 7 - Authorization Manager Control Panel

When we run the Test Plan, JMeter looks in the Authorization table for the URL it is requesting. If the Base URL matches the URL, then JMeter passes this information along with the request.

You can download the Test Plan, but since it is built as a test for our local server, you will not be able to run it. However, you can use it as a reference in constructing your own Test Plan.

The Cookie Manager element has two functions:
First, it stores and sends cookies just like a web browser. If you have an HTTP Request and the response contains a cookie, the Cookie Manager automatically stores that cookie and will use if, for all future request that particular request. Each JMeter thread has its own "cookie storage area". So, if you are testing a web site that uses a cookie for storing session information, each JMeter thread will have its own session.

Second, you can manually add a cookie to the Cookie Manager. However, if you do this, the cookie will be shared by all JMeter threads.

Descriptive name for this element that is shown in the tree. This gives you the opportunity to use hardcoded cookies that will be used by all threads during the test execution. Add an entry to the cookie table. Delete the currently selected table entry. Load a previously saved cookie table and add the entries to the existing cookie table entries. Save the current cookie table to a file.

The Proxy Server allows JMeter to watch and record your actions while you browse your web application with your normal browser (such as Internet Explorer). JMeter will create test sample objects and store them directly into your test plan as you go (so you can view samples interactively while you make them).

To use the proxy server, add the HTTP Proxy Server element to the workbench. It will appear under the Configuration Element menu list (Add->Config Elements->HTTP Proxy Server).

Descriptive name for this controller that is shown in the tree. The port that the Proxy Server listens to. 8080 is the default, but you can change it if that port is already in use on your machine. Regular expressions that are matched against the full URL that is sampled. Allows filtering of requests that are recorded. All requests pass through, but only those that meet the requirements of the Include/Exclude fields are recorded. If both Include and Exclude are left empty, then everything is recorded (which can result in dozens of samples recorded for each page, as images, stylesheets, etc are recorded). If there is at least one entry in the Include field, then only requests that match one or more Include patterns are recorded. Regular expressions that are matched against the URL that is sampled. Any requests that match one or more Exclude pattern are not recorded. Remove all regular expressions from the list. Start the proxy server. JMeter writes the following message to the console once the proxy server has started up and is ready to take requests: "Proxy up and running!". Stop the proxy server.

To add an entry to the Include or Exclude field, type the entry into the text field, and hit "Enter" when done. The text will be added to the List box to the right of the text field. To clear the text field, hit the "clear" button. Currently, there is no way to individually select items and delete them.

These entries will be treated as Perl-type regular expressions. They will be matched against the host name + the path of each browser request. Thus, if the URL you are browsing is http://jakarta.apache.org/jmeter/index.html?username=xxxx, then the regular expression will be tested against the string: "jakarta.apache.org/jmeter/index.html". Thus, if you wanted to include all .html files, you're regular expression might look like: ".*\.html". Using a combination of includes and excludes, you should be able to record what you are interested in and skip what you are not.

When you are ready to begin, hit "start".

You will need to edit the proxy settings of your browser to point at the appropriate server and port, where the server is the machine JMeter is running on, and the port # is from the Proxy Control Panel shown above. Where Do Samples Get Recorded?

JMeter places the recorded samples in the Thread Group, or if you have a Simple Logic Controller, JMeter places them there. Also, if you have a HTTP Request Defaults element, then the recorded samples will have empty fields for the default values you specified.

If you have more than one Simple Logic Controller, JMeter records the samples to each of your Simple Logic Controllers. We plan to correct this in a future release.

When you are done recording your test samples, stop the proxy server (hit the "stop" button). Remember to reset your browser's proxy settings. Now, you may want to sort and re-order the test script, add timers, listeners, a cookie manager, etc.

This element lets you set default values that your HTTP Request controllers use. For example, if you are creating a Test Plan with 25 HTTP Request controllers and all of the requests are being sent to the same server, you could add a single HTTP Request Defaults element with the "Server Name or IP" field filled in. Then, when you add the 25 HTTP Request controllers, leave the "Server Name or IP" field empty. The controllers will inherit this field value from the HTTP Request Defaults element.

Descriptive name for this controller that is shown in the tree. Domain name or IP address of the web server. Port the web server is listening to. HTTP or HTTPS. HTTP GET or HTTP POST. The path to resource (for example, /servlets/myServlet). If the resource requires query string parameters, add them below in the "Send Parameters With the Request" section. The query string will be generated from the list of parameters you provide. Each parameter has a name and value. The query string will be generated in the correct fashion, depending on the choice of "Method" you made (ie if you chose GET, the query string will be appended to the URL, if POST, then it will be sent separately). Also, if you are sending a file using a multipart form, the query string will be created using the multipart form specifications.

This modifier parses HTML response from the server and extracts links and forms. A URL test sample that passes through this modifier will be examined to see if it "matches" any of the links or forms extracted from the immediately previous response. It would then replace the values in the URL test sample with appropriate values from the matching link or form. Perl-type regular expressions are used to find matches.

Consider a simple example: let's say you wanted JMeter to "spider" through your site, hitting link after link parsed from the HTML returned from your server (this is not actually the most useful thing to do, but it serves as a good example). You would create a , and add the "HTML Link Parser" to it. Then, create a Web Test controller, and set the domain to ".*", and the path likewise. This will cause your test sample to match with any link found on the returned pages. If you wanted to restrict the spidering to a particular domain, then change the domain value to the one you want. Then, only links to that domain will be followed.

A more useful example: given a web polling application, you might have a page with several poll options as radio buttons for the user to select. Let's say the values of the poll options are very dynamic - maybe user generated. If you wanted JMeter to test the poll, you could either create test samples with hardcoded values chosen, or you could let the HTML Link Parser parse the form, and insert a random poll option into your URL test sample. To do this, follow the above example, except, when configuring your Web Test controller's URL options, be sure to choose "POST" as the method. Put in hard-coded values for the domain, path, and any additional form parameters. Then, for the actual radio button parameter, put in the name (let's say it's called "poll_choice"), and then ".*" for the value of that parameter. When the modifier examines this URL test sample, it will find that it "matches" the poll form (and it shouldn't match any other form, given that you've specified all the other aspects of the URL test sample), and it will replace your form parameters with the matching parameters from the form. Since the regular expression ".*" will match with anything, the modifier will probably have a list of radio buttons to choose from. It will choose at random, and replace the value in your URL test sample. Each time through the test, a new random value will be chosen.

Figure 8 - Online Poll Example
One important thing to remember is that you must create a test sample immediately prior that will return an HTML page with the links and forms that are relevant to your dynamic test sample.

The Header Manager lets you add or override HTTP request headers.

Descriptive name for this element that is shown in the tree. Name of the request header. Two common request headers you may want to experiment with are "User-Agent" and "Referer". Request header value. Add an entry to the header table. Delete the currently selected table entry. Load a previously saved header table and add the entries to the existing header table entries. Save the current header table to a file.

Download this example. In this example, we created a Test Plan that tells JMeter to override the default "User-Agent" request header and use a particular Internet Explorer agent string instead. (see figures 9 and 10).

Figure 9 - Test Plan
Figure 10 - Header Manager Control Panel
Descriptive name for this element that is shown in the tree. Descriptive name for this element that is shown in the tree.
13.5 Assertions

The assertion control panel let's you add strings to be tested. These strings can be regular expressions. You can also choose whether the strings will be expected to match the entire response, or if the response is only expected to contain the strings. You can attach multiple assertions to any controller for additionaly flexibility.

Descriptive name for this element that is shown in the tree. Instructs JMeter to test against either the Response Text from the server, or against the URL string that was sampled. Indicates whether the text being tested must CONTAIN or MATCH the test patterns. NOT may also be selected to indicate the text should NOT CONTAIN or NOT MATCH the test patterns. A list of regular expressions to be tested. Each pattern is tested separately. There is no difference between setting up one Assertion with multiple patterns and setting up multiple Assertions with one pattern each (assuming the other options are the same).
Figure 7 - Test Plan
Figure 8 - Assertion Control Panel with Pattern
Figure 9 - Assertion Listener Results (Pass)
Figure 10 - Assertion Listener Results (Fail)
13.6 Timers

If you want to have each thread pause for the same amount of time between requests, use this timer.

Descriptive name for this timer that is shown in the tree. Number of milliseconds to pause.

This timer pauses each thread request for a random amount of time, with most of the time intervals ocurring near a particular value. The total delay is the sum of the Gaussian distributed value (with mean 0.0 and standard deviation 1.0) times the deviation value you specify, and the offset value.

Descriptive name for this timer that is shown in the tree Deviation in milliseconds. Number of milliseconds to pause in addition to the random delay.

This timer pauses each thread request for a random amount of time, with each time interval having the same probability of occurring. The total delay is the sum of the random value and the offset value.

Descriptive name for this timer that is shown in the tree. Maxium random number of milliseconds to pause. Number of milliseconds to pause in addition to the random delay.
13.7 Miscellaneous Features

The Data Analyzer presents a graphical view of data stored using the .

To use the Data Analyzer, goto the Report --> Analyze Data File main menu option. Then, when prompted, select the file where the data is stored. JMeter will present the data as a graph with multiple lines. Each line represents a different HTTP Request from your test and its response times.


Copyright © 1999-2001, Apache Software Foundation