About Overview Download Releases Download Nightly Tarball Changes Known Bugs License TODO Contributors Documentation User Manual Developer Manual JMeter Wiki Community Get Involved Mailing Lists CVS Repositories | 13.1 Samplers FTP Request HTTP Request JDBC Request Java Request SOAP/XML-RPC Request 13.2 Logic Controllers Interleave Controller Loop Controller Once Only Controller Simple Controller Random Controller Recording Controller 13.3 Listeners Mailer Visualizer Graph Full Results Graph Results Spline Visualizer Assertion Results View Results Tree Aggregate Report View Results in Table 13.4 Configuration Elements HTTP Authorization Manager HTTP Cookie Manager HTTP Proxy Server HTTP Request Defaults FTP Request Defaults JDBC Database Connection Pool Defaults JDBC Database Login Defaults JDBC SQL Query Defaults HTTP Header Manager User Parameters Counter 13.5 Assertions Response Assertion Duration Assertion 13.6 Timers Constant Timer Gaussian Random Timer Uniform Random Timer Constant Throughput Timer 13.7 Modifiers HTML Link Parser HTTP URL Re-writing Modifier HTML Parameter Mask HTTP User Parameter Modifier 13.8 Miscellaneous Features SSL Manager 13.9 Functions __regexFunction __counter __threadNum __sumInt
13.1 Samplers
> ### 13.1.1 FTP Request
> 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 FTP Request Defaults Configuration Element so you do not have to enter the same information for each FTP Request Generative Controller. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Server Name or IP | Domain name or IP address of the FTP server. JMeter assumes the FTP server is listening on the default port. | Yes
> File to Retrieve From Server | Path and name of the file to retrieve. | Yes
> Username | FTP account username. | Usually
> Password | FTP account password. | Usually
> See Also: Assertions FTP Request Defaults Building an FTP Test Plan
> ### 13.1.2 HTTP Request
> This sampler 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 HTTP Request Defaults Configuration Element so you do not have to enter the same information for each HTTP Request. Or, instead of manually adding HTTP Requests, you may want to use JMeter's HTTP Proxy Server 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 HTTP Authorization Manager Configuration Element. And, if the request uses cookies, then you will also need an HTTP Cookie Manager . 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.1 Handling User Sessions With URL Rewriting for additional configuration steps. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Server | Domain name or IP address of the web server. | Yes
> Port | Port the web server is listening to. | No (defaults to 80)
> Protocol | HTTP or HTTPS. | Yes
> Method | HTTP GET or HTTP POST. | Yes
> Path | 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. | Yes
> Send Parameters With the Request | 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. Additionally, you can specify whether each paramter should be URL encoded. If you are not sure what this means, it is probably best to select it. If your values contain characters such as & or spaces, or question marks, then encoding is usually required. | No
> Filename | 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. | No
> Parameter Name | Name of the web request parameter. | No (Yes if Filename filled in)
> MIME Type | MIME type (for example, text/plain). | No (Yes if Filename filled in)
> Retrieve All Images and Java Applets | Tell JMeter to parse the HTML file and send HTTP/HTTPS requests for all images and Java applets referenced in the file. | No
> See Also: Assertion Building a Web Test Plan Building an Advanced Web Test Plan HTTP Authorization Manager HTTP Cookie Manager HTTP Header Manager HTML Link Parser HTTP Proxy Server HTTP Request Defaults HTTP Requests and Session ID's: URL Rewriting
> ### 13.1.3 JDBC Request
> This sampler 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: JDBC Database Login Defaults , JDBC Database Connection Pool Defaults , JDBC SQL Query Defaults . This way, you do not have to enter the same information for each JDBC Request controller. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> JDBC URL | URL of the database (for example, "jdbc:weblogic:oracle"). Refer to your database's JDBC documentation for the URL you should use. | Yes
> Driver Class | 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. | Yes
> Username | FTP account username. | Usually (database dependent)
> Password | FTP account password. | Usually (database dependent)
> Number of Connections in Pool | 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. | Yes
> Max Usage For Each Connection | Maximum number of times JMeter uses a database connection instance before recycling it (destroying and creating a new instance). | Yes
> SQL Query String | SQL query (for example, "select * from t_customers"). | Yes
> See Also: Assertion Building a Database Test Plan JDBC Database Login Defaults JDBC Database Connection Pool Defaults JDBC SQL Query Defaults
> ### 13.1.4 Java Request
> This sampler lets you control a java class that implements the JavaSamplerClient interface. By writing your own implementation of this interface, you can use JMeter to harness multiple threads, input parameter control, and data collection. The pull-down menu provides the list of all such implementations found by JMeter in its classpath. The parameters can then be specified in the table below - as defined by your implementation. A simple example (SleepTest) is provided. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this sampler that is shown in the tree. | No
> Classname | The specific implementation of the JavaSamplerClient interface to be sampled. | Yes
> Send Parameters with Request | A list of arguments that will be passed to the sampled class. All arguments are sent as Strings. | No
> ### 13.1.5 SOAP/XML-RPC Request
> This sampler lets you send a SOAP request to a webservice. It can also be used to send XML-RPC over HTTP. It creates an HTTP POST request, with the specified XML as the POST content. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this sampler that is shown in the tree. | No
> URL | The URL to direct the SOAP request to. | Yes
> Soap/XML-RPC Data | The Soap XML message, or XML-RPC instructions. | No
13.2 Logic Controllers
> ### 13.2.1 Interleave Controller
> If you add Generative or Logic Controllers to an Interleave Controller, JMeter will alternate among each of the other controllers for each loop iteration. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> name | Descriptive name for this controller that is shown in the tree. | No
> Simple Interleave Example 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 Iteration | Each JMeter Thread Sends These HTTP Requests
> 1 | News Page
> 2 | FAQ Page
> 3 | Gump Page
> 4 | Because there are no more requests in controller, JMeter start over and sends the first HTTP Request, which is the News Page.
> 5 | FAQ Page
> Note, the File Reporter is configured to store the results in a file named "interleave-test.dat" in the current directory. Useful Interleave Example 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.
> ### 13.2.2 Loop Controller
> 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Loop Count | 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. | Yes, unless "Forever" is checked
> Looping Example 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.
> ### 13.2.4 Once Only Controller
> 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Once Only Example 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.
> ### 13.2.5 Simple Controller
> The Simple Logic Controller lets you organize your Samplers and other Logic Controllers. Unlike other Logic Controllers, this controller provides no functionality beyond that of a storage device. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Using the Simple Controller 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.2.6 Random Controller
> The Random Logic Controller acts similarly to the Interleave Controller, except that instead of going in order through its sub-controllers and samplers, it picks one at random at each pass.
> Interactions between multiple controllers can yield complex behavior. This is particularly true of the Random Controller. Experiment before you assume what results any given interaction will give
> Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> ### 13.2.7 Recording Controller
> The Recording Controller is a place holder indicating where the proxy server should record samples to. During test run, it has no effect, similar to the Simple Controller. But during recording using the HTTP Proxy Server , all recorded samples will be saved under the Recording Controller. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
13.3 Listeners
> Most of the listeners perform several roles in addition to "listening" to the test results. They frequently also provide means to view, save, and read saved test results. The saving and reading of test results is generic. The various listeners generally have a panel whereby one can specify the file to which the results will be written (or read). The results are stored as XML files, typically with a ".jtl" extension. The information to be saved is configurable. If one specifies the "Functional Test Mode" on the Test Plan element, one gets the largest amount of information. If this box is not checked, the default saved data includes a time stamp (the number of milliseconds since midnight, January 1, 1970 UTC), the data type, the thread name, the label, the response time, message, and code, and a success indicator. One can get a more selective set of information my modifying the jmeter.properties file. The following example indicates how to set these. ``
>     #---------------------------------------------------------------------------
>     # Results file configuration
>     #---------------------------------------------------------------------------

>     # This section helps determine how result data will be saved.
>     # The commented out values are the defaults.

>     # legitimate values: xml, csv, db.  Only xml is currently supported.
>     #jmeter.save.saveservice.output_format=xml

>     # true when field should be saved; false otherwise

>     jmeter.save.saveservice.data_type=false
>     jmeter.save.saveservice.label=true
>     jmeter.save.saveservice.response_code=false
>     jmeter.save.saveservice.response_data=false
>     jmeter.save.saveservice.response_message=false
>     jmeter.save.saveservice.successful=true
>     jmeter.save.saveservice.thread_name=false
>     jmeter.save.saveservice.time=false

>     # legitimate values: none, ms, or a format suitable for SimpleDateFormat
>     #jmeter.save.saveservice.timestamp_format=ms
>     jmeter.save.saveservice.timestamp_format=MM/dd/yy HH:mm:ss

>     # legitimate values: none, first, all
>     jmeter.save.saveservice.assertion_results=first
> The date format to be used for the timestamp is described in SimpleDateFormat . Bear in mind that choosing a date format other than "ms" is likely to make it impossible for JMeter to interpret the value when it is read in later for viewing purposes. The viewing capabilities are described in the following subsections.
> ### 13.3.1 Mailer Visualizer
> The mailer visualizer can be set up to send email if a test run receives too many failed responses from the server. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> From | Email address to send messages from. | Yes
> Addressie(s) | Email address to send messages to. | Yes
> SMTP Host | IP address or host name of SMTP (email redirector) server. | No
> Failure Subject | Email subject line for fail messages. | No
> Success Subject | Email subject line for success messages. | No
> Failure Limit | Once this number of failed responses are received, a failure email is sent. | Yes
> Success Limit | Once this number of successful responses are received after previously reaching the failure limit , a success email is sent. The mailer will thus only send out messages in a sequence of failed-succeeded-failed-succeeded, etc. | Yes
> Test Mail |  | No
> Failures | A field that keeps a running total of number of failures so far received. | No
> ### 13.3.2 Graph Full Results
> No Description
> ### 13.3.3 Graph Results
> The Graph Results listener generates a simple graph that plots all sample times. Along the bottom of the graph, the current sample (black), the current average of all samples(blue), the current standard deviation (red), and the current throughput rate (green) are displayed in milliseconds. The throughput number represents the actual number of requests/minute the server handled. This calculation includes any delays you added to your test and JMeter's own internal processing time. The advantage of doing the calculation like this is that this number represents something real - your server in fact handled that many requests per minute, and you can increase the number of threads and/or decrease the delays to discover your server's maximum throughput. Whereas if you made calculations that factored out delays and JMeter's processing, it would be unclear what you could conclude from that number. Control Panel
> ### 13.3.4 Spline Visualizer
> 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. Control Panel
> ### 13.3.5 Assertion Results
> 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. Control Panel See Also: Basic Assertion
> ### 13.3.6 View Results Tree
> 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. There are two ways two view the response, controllable by a push button. The default view shows all of the text contained in the response. The alternative view attempts to render the response as HTML. The rendered HTML is likely to compare poorly to the view one would get in any web browser; however, it does provide a quick approximation that is helpful for initial result evaluation. Control Panel
> ### 13.3.7 Aggregate Report
> The aggregate report creates a table row for each differently named request in your test. For each request, it totals the response information and provides request count, min, max, average, error rate, and an idealized throughput calculation. Control Panel
> ### 13.3.7 View Results in Table
> This visualizer creates a row for every sample result. Each sample result's URL, time in milliseconds, success/failure is displayed. Like the View Results Tree , this visualizer uses a lot of memory. Control Panel
13.4 Configuration Elements
> ### 13.4.1 HTTP Authorization Manager
> 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.
> Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> Base URL | 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". | Yes
> Username | The username to authorize. | Yes
> Password | The password to authorize. | Yes
> 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.
> Authorization Example 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.
> ### 13.4.2 HTTP Cookie Manager
> 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 it for all future requests to that particular web site. 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> Cookies Stored in the Cookie Manager | This gives you the opportunity to use hardcoded cookies that will be used by all threads during the test execution. | No (discouraged, unless you know what you're doing)
> Add Button | Add an entry to the cookie table. | N/A
> Delete Button | Delete the currently selected table entry. | N/A
> Load Button | Load a previously saved cookie table and add the entries to the existing cookie table entries. | N/A
> Save As Button | Save the current cookie table to a file. | N/A
> ### 13.4.3 HTTP Proxy Server
> 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. Select the WorkBench element in the tree, and right-click on this element to get the Add menu (Add --> Non-Test Elements --> HTTP Proxy Server). Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Port | 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. | Yes
> Patterns to Include | 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 . | No
> Patterns to Exclude | Regular expressions that are matched against the URL that is sampled. Any requests that match one or more Exclude pattern are not recorded . | No
> Clear Buttons | Remove all regular expressions from the list. | N/A
> Start Button | 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!". | N/A
> Stop Button | Stop the proxy server. | N/A
> Restart Button | Stops and restarts the proxy server. This is useful when you change/add/delete an include/exclude filter expression. | N/A
> 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.
> ### 13.4.4 HTTP Request Defaults
> 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this controller that is shown in the tree. | No
> Server | Domain name or IP address of the web server. | Yes
> Port | Port the web server is listening to. | No (defaults to 80)
> Protocol | HTTP or HTTPS. | Yes
> Method | HTTP GET or HTTP POST. | Yes
> Path | 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. | Yes
> Send Parameters With the Request | 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. | No
> ### 13.4.5 FTP Request Defaults
> Control Panel
> ### 13.4.6 JDBC Database Connection Pool Defaults
> Control Panel
> ### 13.4.7 JDBC Database Login Defaults
> Control Panel
> ### 13.4.8 JDBC SQL Query Defaults
> Control Panel
> ### 13.4.9 HTTP Header Manager
> The Header Manager lets you add or override HTTP request headers. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> Name (Header) | Name of the request header. Two common request headers you may want to experiment with are "User-Agent" and "Referer". | No (You should have at least one, however)
> Value | Request header value. | No (You should have at least one, however)
> Add Button | Add an entry to the header table. | N/A
> Delete Button | Delete the currently selected table entry. | N/A
> Load Button | Load a previously saved header table and add the entries to the existing header table entries. | N/A
> Save As Button | Save the current header table to a file. | N/A
> Header Manager example 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
> ### 13.4.10 User Parameters
> Allows the user to specify values for User Variables specific to individual threads. User Variables can also be specified in the Test Plan but not specific to individual threads. This panel allows you to specify a series of values for any User Variable. For each thread, the variable will be assigned one of the values from the series in sequence. If there are more threads than values, the values get re-used. For example, this can be used to assign a distinct user id to be used by each thread. User variables can be referenced in any field of any jMeter Component. The variable is specified by clicking the Add Variable button in the bottom of the panel and filling in the Variable name in the 'Name:' column. To add a new value to the series, click the 'Add User' button and fill in the desired value in the newly added column. Values can be accessed in any test component in the same thread group, using the function syntax : ${variable}. Control Panel
> ### 13.4.11 Counter
> Allows the user to create a counter that can be referenced anywhere in the Thread Group. The counter config lets the user configure a starting point, a maximum, and the increment. The counter will loop from the start to the max, and then start over with the start, continuing on like that until the test is ended. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> Start | The starting number for the counter. The counter will equal this number during the first iteration. | Yes
> Increment | How much to increment the counter by after each iteration. | Yes
> Maximum | If the counter exceeds the maximum, then it is reset to the Start value. | Yes
> Reference Name | This controls how you refer to this value in other elements. Syntax is as in user-defined values : `$(reference_name}` . | Yes
> Track Counter Independently for each User | In other words, is this a global counter, or does each user get their own counter? If unchecked, the counter is global (ie, user #1 will get value "1", and user #2 will get value "2" on the first iteration). If checked, each user has an independent counter. | No
13.5 Assertions
> ### 13.5.1 Response Assertion
> The response 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> Response Field to Test | Instructs JMeter to test against either the Response Text from the server, or against the URL string that was sampled. | Yes
> Pattern Matching Rules | 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. | Yes
> Patterns to Test | 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). | Yes
> Assertion Examples
> Figure 7 - Test Plan
> Figure 8 - Assertion Control Panel with Pattern
> Figure 9 - Assertion Listener Results (Pass)
> Figure 10 - Assertion Listener Results (Fail)
> ### 13.5.2 Duration Assertion
> The Duration Assertion tests that each response was received within a given amount of time. Any response that takes longer than the given number of milliseconds (specified by the user) is marked as a failed response. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this element that is shown in the tree. | No
> Duration in Milliseconds | The maximum number of milliseconds each response is allowed before being marked as failed. | Yes
13.6 Timers
> ### 13.6.1 Constant Timer
> If you want to have each thread pause for the same amount of time between requests, use this timer. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this timer that is shown in the tree. | No
> Thread Delay | Number of milliseconds to pause. | Yes
> ### 13.6.2 Gaussian Random Timer
> 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this timer that is shown in the tree | No
> Deviation | Deviation in milliseconds. | Yes
> Constant Delay Offset | Number of milliseconds to pause in addition to the random delay. | Yes
> ### 13.6.3 Uniform Random Timer
> 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. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this timer that is shown in the tree. | No
> Random Delay Maximum | Maxium random number of milliseconds to pause. | Yes
> Constant Delay Offset | Number of milliseconds to pause in addition to the random delay. | Yes
> ### 13.6.4 Constant Throughput Timer
> This timer introduces variable pauses, calculated to keep the total throughput (in terms of samples per minute) as close as possible to a give figure. Of course the throughput will be lower if the server is not capable of handling it, or if other timers or time-consuming test elements prevent it. Only samples within the container where you put the timer count towards the calculated throughput. Also note that the total time (used in the denominator to calculate the throughput) starts counting with the first such sample -- not with the test start. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name for this timer that is shown in the tree. | No
> Target Throughput | Throughput we want the timer to try to generate. | Yes
13.7 Modifiers
> ### 13.7.1 HTML Link Parser
> 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. Spidering Example 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 Simple Controller , and add the "HTML Link Parser" to it. Then, create a HTTP Request, 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. Poll Example 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.
> ### 13.7.2 HTTP URL Re-writing Modifier
> This modifier works similarly to the HTML Link Parser, except it has a specific purpose for which it is easier to use than the HTML Link Parser, and more efficient. For web applications that use URL Re-writing to store session ids instead of cookies, this element can be attached at the ThreadGroup level, much like the HTTP Cookie Manager . Simply give it the name of the session id parameter, and it will find it on the page and add the argument to every request of that ThreadGroup. Alternatively, this modifier can be attached to select requests and it will modify only them. Clever users will even determine that this modifier can be used to grab values that elude the HTML Link Parser . Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name given to this element in the test tree. | No
> Session Argument Name | The name of the parameter to grab from previous response. This modifier will find the parameter anywhere it exists on the page, and grab the value assigned to it, whether it's in an HREF or a form. | Yes
> Path Extension | Some web apps rewrite URLs by appending a semi-colon plus the session id parameter. Check this box if that is so. | No
> ### 13.7.3 HTML Parameter Mask
> * - This element is deprecated. Use Counter instead
> The HTML Parameter Mask is used to generate unique values for HTML arguments. By specifying the name of the parameter, a value prefix and suffix, and counter parameters, this modifier will generate values of the form " `name=prefixcountersuffix` ". Any HTTP Request that it modifies, it will replace any parameter with the same name or add the appropriate parameter to the requests list of arguments.
> The value of the argument in your HTTP Request must be a '*' in order for the HTML Parameter Mask Modifier to replace it.
> As an example, the username for a login script could be modified to send a series of values such as: user_1 user_2 user_3 user_4, etc. Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name given to this element in the test tree. | No
> Name (second appearing) | The name of the parameter to modify or add to the HTTP Request. | Yes
> ID Prefix | A string value to prefix to every generated value. | No
> Lower Bound | A number value to start the counter at. | Yes
> Upper Bound | A number value to end the counter, at which point it restarts with the Lower Bound value. | Yes
> Increment | Value to increment the counter by each time through. | Yes
> ID Suffix | A string value to add as suffix to every generated vaue. | No
> ### 13.7.4 HTTP User Parameter Modifier
> * - This element is deprecated. Use User Parameters instead
> The User Parameter Modifier uses an XML file get values for HTTP arguments. Any HTTP Request that this modifier modifies will be checked for the existence of the specified arguments. If found, the values for those arguments will be replaced by the values found in the xml file. The XML file can have multiple sets of the same values. This modifier will iterate through these values in a round-robin style, thus each request will get a different set of values until the last set of values is reached, at which point it will begin again at the first set.
> If the number of value sets is equal to the number of threads in your test, then it will work out that each thread will get the same set of values each time, which will be a different set from any other thread
> Control Panel Parameters
> Attribute | Description | Required
> --- | --- | ---
> Name | Descriptive name given to this element in the test tree. | No
> File Name | Name of the XML file in JMeter's /bin directory that holds the value sets. | Yes
13.8 Miscellaneous Features
> ### 13.8.1 SSL Manager
> The SSL Manager is a way to select a client certificate so that you can test applications that use Public Key Infrastructure (PKI). In order to use it, you must have JSSE 1.0.2 installed. Unfortunately, there is no standard method for controling who a client is--and that won't be introduced until JDK 1.4 is officially available. The SSL Manager should still work with JDK 1.4, so this is the best solution we could come up with. Choosing a Client Certificate You may either use a Java Key Store (JKS) format key store, or a Public Key Certificate Standard #12 (PKCS12) file for your client certificates. There is a bug in the JSSE libraries that require you to have at least a six character password on your key (at least for the keytool utility that comes with your JDK). To select the client certificate, choose Options->SSL Manager from the menu bar. You will be presented with a file finder that looks for PKCS12 files by default. Your PKCS12 file must have the extension '.p12' for SSL Manager to recognize it as a PKCS12 file. Any other file will be treated like an average JKS key store. If JSSE is correctly installed, you will be prompted for the password. The text box does not hide the characters you type at this point--so make sure no one is looking over your shoulder. The current implementation assumes that the password for the keystore is also the password for the private key of the client you want to authenticate as. The next time you run your test, the SSL Manager will examine your key store to see if it has more than one key available to it. If there is only one key, SSL Manager will select it for you. If there is more than one key, you will be prompted to select the alias you wish to authenticate as. If SSL Manager cannot detect any keys in your keystore, it will give you a text box for the off chance you know something it doesn't. Keep in mind that for the first run, you will be prompted once per thread. Try to use only one thread for the first run to ensure everything is working properly. Things to Look Out For You must have your Certificate Authority (CA) certificate installed properly if it is not signed by one of the five CA certificates that ships with your JDK. One method to install it is to import your CA certificate into a JKS file, and name the JKS file "jssecacerts". Place the file in your JRE's lib/security folder. This file will be read before the "cacerts" file in the same directory. Keep in mind that as long as the "jssecacerts" file exists, the certificates installed in "cacerts" will not be used. This may cause problems for you. If you don't mind importing your CA certificate into the "cacerts" file, then you can authenticate against all of the CA certificates installed.
13.9 Functions
> Please read the general description of how functions work. Here is given only the details of specific functions.
> ### 13.9.1 __regexFunction
> The Regex Function is used to parse the previous response using any regular expression (provided by user). The function returns the template string with variable values filled in. The __regexFunction stores values for future use. In the sixth parameter, you can specify a reference name. After this function executes, the same values can be retrieved at later times using the syntax for user-defined values. For instance, if you enter "refName" as the sixth parameter you will be able to use: ${refName} to refer to the computed result of the second parameter ("Template for the replacement string") parsed by this function ${refName_g0} to refer to the entire match parsed by this function. ${refName_g1} to refer to the first group parsed by this function. ${refName_g#} to refer to the n th group parsed by this function. Parameters
> Attribute | Description | Required
> --- | --- | ---
> First arguement | The first argument is the regular expression to be applied to the response data. It will grab all matches. Any parts of this expression that you wish to use in your template string, be sure to surround in parentheses. Example: <a href="(.*)">. This will grab the value of the link and store it as the first group (there is only 1 group). Another example: <input type="hidden" name="(.*)" value="(.*)">. This will grab the name as the first group, and the value as the second group. These values can be used in your template string | Yes
> Second argument | This is the template string that will replace the function at run-time. To refer to a group captured in the regular expression, use the syntax: $[group_number]$. Ie: $1$, or $2$. Your template can be any string. | Yes
> Third argument | The third argument tells JMeter which match to use. Your regular expression might find numerous matches. You have four choices: An integer - Tells JMeter to use that match. '1' for the first found match, '2' for the second, and so on RAND - Tells JMeter to choose a match at random. ALL - Tells JMeter to use all matches, and create a template string for each one and then append them all together. This option is little used. A float number between 0 and 1 - tells JMeter to find the Xth match using the formula: (number_of_matches_found * float_number) rounded to nearest integer. | Yes
> Fourth argument | If 'ALL' was selected for the above argument value, then this argument will be inserted between each appended copy of the template value. | No
> Fifth argument | Default value returned if no match is found | No
> Sixth argument | A reference name for reusing the values parsed by this function. Stored values are ${refName} (the replacement template string) and ${refName_g#} where "#" is the group number from the regular expression ("0" can be used to refer to the entire match). | No
> ### 13.9.2 __counter
> The counter generates a new number each time it is called, starting with 1 and incrementing by +1 each time. The counter can be configured to keep each simulated user's values separate, or to use the same counter for all user. If each user's values is incremented separately, that is like counting the number of iterations through the test plan. A global counter is like counting how many times that request was run. Parameters
> Attribute | Description | Required
> --- | --- | ---
> First argument | TRUE if you wish each simulated user's counter to be kept independent and separate from the other users. FALSE for a global counter. | Yes
> Second argument | A reference name for reusing the value created by this function. Stored values are of the form ${refName}. This allows you to keep one counter and refer to its value in multiple places. | No
> ### 13.9.3 __threadNum
> The thread number function simply returns the number of the thread currently being executed. These numbers are independent of ThreadGroup, meaning thread #1 in one threadgroup is indistinguishable from thread #1 in another threadgroup, from the point of view of this function. There are no arguments for this function.
> ### 13.9.4 __sumInt
> The sumInt function can be used to compute the sum of two or more integer values. Parameters
> Attribute | Description | Required
> --- | --- | ---
> First argument | The first int value. | Yes
> Second argument | The second int value. | Yes
> nth argument | The nth int value. | No
> last argument | A reference name for reusing the value computed by this function. | Yes
Copyright © 1999-2001, Apache Software Foundation