2. Getting Started

The easiest way to begin using JMeter is to first download the latest production release and install it. The release contains all of the files you need to build and run Web, FTP, JDBC, and JNDI tests. If you want to perform JDBC testing, then you will, of course, need the appropriate JDBC driver from your vendor. JMeter does not come with any JDBC drivers.

Next, start JMeter and go through the Building a Test Plan section of the User Guide to familiarize yourself with JMeter basics (for example, adding and removing elements).

Finally, go through the appropriate section on how to build a specific type of Test Plan. For example, if you are interested in testing a Web application, then see the section Building a Web Test Plan . The other specific Test Plan sections are for JDBC , FTP , and JNDI .

Once you are comfortable with building and running JMeter Test Plans, you can look into the various configuration elements (timers, listeners, assertions, and others) which give you more control over your Test Plans.

2.1 Requirements

JMeter requires your computing environment meets some minimum requirements.

2.1.1 Java Version

JMeter (as of version 1.8) requires a fully compliant JDK1.4 (or higher) environment. Because JMeter uses only standard Java APIs (java.*), please do not file bug reports if your JRE fails to run JMeter because of JRE implementation issues.

JDK1.4.1Beta appears to be buggy, and there are some GUI elements that won't work correctly in this JVM.

2.1.2 Operating Systems

JMeter has been tested and works under Unix (Solaris, Linux, etc) and Windows (98, NT, 2000). JMeter is a 100% Java application and should run correctly on any system that has a compliant Java implementation.

2.2 Optional

If you plan on doing JMeter development or want to use Sun's Java Standard Extension packages, then you will need one or more optional packages listed below.

2.2.1 Java Compiler

If you want to build the JMeter source or develop JMeter plugins, then you will need a fully compliant JDK1.2 or higher compiler.

2.2.2 SAX XML Parser

JMeter comes with Apache's Xerces XML parser . You have the option of telling JMeter to use a different XML parser. To do so, include the classes for the third-party parser in JMeter's classpath , and update the file with the full classname of the parser implementation.

2.2.3 Email Support

JMeter has limited Email capabilities (it can send email based on test results). To enable Email support, add Sun's JavaMail packages to JMeter's classpath .

2.2.4 SSL Encryption

To test a web server using SSL encryption (HTTPS), JMeter requires that an implementation of SSL be provided (such as Sun's Java Secure Sockets Extension -- JSSE ). Include the necessary encryption packages in JMeter's classpath . Also, update by registering the SSL Provider.

There is also the SSL Manager , for greater control of certs.

Note: if you are running JDK1.4, then you do not have to download JSSE because Sun integrated it into JDK1.4 as a standard library.

2.2.5 JDBC Driver

You will need to add your database vendor's JDBC driver to the classpath if you want to do JDBC testing.

2.3 Installation

Installing JMeter is a snap. Specifics depend on which release file you downloaded.

2.3.1 Downloading the Latest Release

We recommend that most users run the latest release .

To install a release build, simply unzip the zip/tar file into the directory where you want JMeter to be installed. Provided that you have a JDK correctly installed and the JAVA_HOME environment variable set, there is nothing more for you to do.

2.3.2 Downloading Nightly Builds

If you do not mind working with beta-quality software, then you can download and run the latest nightly build .

To install a nightly build, unzip the zip/tar file into the directory where you want JMeter to be installed. Then, open a shell or command prompt and change to JMeter's top-level directory. Next, type "build install". Provided that you have a JDK correctly installed and the JAVA_HOME environment variable set, JMeter should be installed successfully.

2.4 Running JMeter

To run JMeter, run the jmeter.bat (for Windows) or jmeter (for Unix) file.

2.4.1 JMeter's Classpath

JMeter automatically finds classes from jars in its /lib and /lib/ext directories. If you want to add other JAR files to JMeter's classpath, then you must copy them to JMeter's "lib" directory. If you have developed new JMeter specific components, then you should jar them and copy the jar into JMeter's /lib/ext directory. JMeter will automatically find JMeter components in any jars found here.

2.4.2 Using a Proxy Server

If you are testing from behind a firewall/proxy server, you may need to provide JMeter with the firewall/proxy server hostname and port number. To do so, run the jmeter.bat/jmeter file from a command line with the following parameters:

-H [proxy server hostname or ip address]

-P [proxy server port]

-u [username for proxy authentication - if required]

-a [password for proxy authentication - if required]

Example : jmeter -H my.proxy.server -P 8000 -u username -a password

Alternatively, you can use --proxyHost, --proxyPort, --username, and --password

2.4.3 Non-GUI Mode

For non-interactive testing, you may choose to run JMeter without the GUI. To do so, use the following command options

-n This specifies JMeter is to run in non-gui mode

-t [name of JMX file that contains the Test Plan].

-l [name of JTL file to log sample results to.

The script also lets you specify the optional firewall/proxy server information:

-H [proxy server hostname or ip address]

-P [proxy server port]

Example : jmeter -n -t my_test.jmx -l log.jtl -H my.proxy.server -P 8000

2.4.4 Server Mode

For distributed testing , run JMeter in server mode, and then control each server from the GUI.

You must first run rmiregistry from your JDK installation with the ApacheJMeter_core.jar added to your system classpath. ApacheJMeter_core.jar resides in JMeter's /lib/ext directory.

Then, run JMeter, using the -s option:

-s This specifies JMeter is to run as a server

The script also lets you specify the optional firewall/proxy server information:

-H [proxy server hostname or ip address]

-P [proxy server port]

Example : jmeter -s -H my.proxy.server -P 8000

2.5 Configuring JMeter

If you wish to modify the properties with which JMeter runs you need to either modify the inside of the /bin directory or create your own copy of the and specify it in the command line (jmeter [properties file]).


ssl.provider You must specify the class for your SSL implementation. If you are using the JSSE from sun, then it is:
You can specify an implementation as your XML parser. The default value is: org.apache.xerces.parsers.SAXParser No
user.dir The directory JMeter will first go to for saving and loading test scripts. No
remote_hosts Comma-delimited list of remote JMeter hosts. If you are running JMeter in a distributed environment, list the machines where you have JMeter remote servers running. This will allow you to control those servers from this machine's GUI No
not_in_menu A list of components you do not want to see in JMeter's menus. As JMeter has more and more components added, you may wish to customize your JMeter to show only those components you are interested in. You may list their classname or their class label (the string that appears in JMeter's UI) here, and they will no longer appear in the menu's. No

Copyright © 1999-2001, Apache Software Foundation