Index | Next | Prev

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.

> Other software that you may want to download:

> - BeanShell
> - Java Activation Framework - needed for JavaMail
> - Java Mail - needed for mail visualiser and SOAP tests
> - JMS - for JMS samplers
> - General Java download page

> See the JMeter Classpath section for details on installing additional jars.

> 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 requires a fully compliant JVM 1.3 or higher. We are making a strong effort currently to be compatible with the 1.3 JVM's, though it is expected JMeter performs best with 1.4 or better.

> > Because JMeter uses only standard Java APIs, please do not file bug reports if your JRE fails to run JMeter because of JRE implementation issues.

> > Java 1.3 does not include SSL (HTTPS) support - you'll need to download JSSE. Also, it does not perform as well as later Java versions. Use the latest version of Java 1.4 or 1.5 for best results

> 2.1.2 Operating Systems

> > JMeter is a 100% Java application and should run correctly on any system that has a compliant Java implementation.
> > JMeter has been tested and works under:

> > - Unix (Solaris, Linux, etc)
> > - Windows (98, NT, 2000, XP)
> > - OpenVMS Alpha 7.3+

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 JDK 1.3 or higher.

> 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 jmeter.properties 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, and has a POP/IMAP sampler. It does not currently support SMTP sampling. To enable Email support, add Sun's JavaMail packages and the activation 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 jmeter.properties by registering the SSL Provider.

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

> > 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.

> > The JMeter proxy server (see below) does not support recording SSL (https).

> 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. Make sure the file is a jar file, not a zip.

> 2.2.6 Apache SOAP

> > Apache SOAP requires mail.jar and activation.jar. You need to download and copy these two jar files to your jmeter/lib directory. Once the files are in there, JMeter will automatically pick them up.

> See the JMeter Classpath section for details on installing additional jars.

2.3 Installation

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

> Note: avoid installing JMeter in a path with spaces in the name. This causes problems for remote testing.

> 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 JRE/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 _bin and _lib zip/tar files into the same directory structure. Provided that you have a JRE/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. JMeter must be started from the JMeter bin directory (where those files are found). The jmeter.bat file attempts to change to the appropriate directory if it can.

> 2.4.1 JMeter's Classpath

> > JMeter automatically finds classes from jars in its /lib and /lib/ext directories. If you have developed new JMeter 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. If you don't want to put the extension jars in the lib/ext directory, then define the property search_paths in jmeter.properties. Do not use lib/ext for utility jars; it is only intended for JMeter components.

> > Other jars (such as JDBC, and any support libaries needed by the JMeter code) should be placed in the lib directory.

> > Note: JMeter will only find .jar files, not .zip.

> > You can also install utility Jar files in $JAVA_HOME/jre/lib/ext, or (since 2.1.1) you can set the property user.classpath in jmeter.properties

> > Note that setting the CLASSPATH environment variable will have no effect. This is because JMeter is started with "java -jar", and the java command silently ignores the CLASSPATH variable, and the -classpath/-cp options when -jar is used. [This occurs with all Java programs, not just JMeter.]

> 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]
> > -N [nonproxy hosts] (e.g. *.apache.org|localhost)
> > -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 -N localhost

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

> > JMeter also has its own in-built HTTP Proxy Server , which can be used for recording HTTP (but not HTTPS) browser sessions. This is not to be confused with the proxy settings described above, which are used when JMeter makes HTTP or HTTPS requests itself.

> 2.4.3 Non-GUI Mode (Command Line 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].

> > -r Run all remote servers specified in jmeter.properties (or remote servers specified on command line by overriding properties)

> > 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.

> > The jmeter-server/jmeter-server.bat script should start rmiregistry for you with the appropriate classpath. if it fails to do so, read the details about starting the jmeter server.

> > Run jmeter-server/jmeter-server.bat, plus these optional commands:

> > 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-server -H my.proxy.server -P 8000

> 2.4.5 Overriding Properties Via The Command Line

> > Java system properties, JMeter properties, and logging properties can be overriden directly on the command line (instead of modifying jmeter.properties). To do so, use the following options:

> > -D[prop_name]=[value] - defines a java system property value.

> > -J[prop name]=[value] - overrides a JMeter property.

> > -L[category]=[priority] - overrides a logging setting, setting a particular category to the given priority level.

> > The -L flag can also be used without the category name to set the root logging level.

> > Examples :

> >     jmeter -Duser.dir=/home/mstover/jmeter_stuff \
> >         -Jremote_hosts=127.0.0.1 -Ljmeter.engine=DEBUG

> >     jmeter -LDEBUG

> > N.B.
> > The command line properties are processed early in startup, but after the logging system has been set up. Attempts to use the -J flag to update log_level or log_file properties will have no effect.

> 2.4.6 Logging and error messages

> > If JMeter detects an error, a message will be written to the log file. The log file name is defined in the jmeter.properties file. It is normally defined as jmeter.log , and will be found in the JMeter startup directory, i.e. bin.

> > When running on Windows, the file may appear as just jmeter unless you have set Windows to show file extensions. [Which you should do anyway, to make it easier to detect viruses and other nasties that pretend to be text files...]

> > As well as recording errors, the jmeter.log file records some information about the test run. For example:

> >     10/17/2003 12:19:20 PM INFO  - jmeter.JMeter: Version 1.9.20031002
> >     10/17/2003 12:19:45 PM INFO  - jmeter.gui.action.Load: Loading file: c:\mytestfiles\BSH.jmx
> >     10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Running the test!
> >     10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Starting 1 threads for group BSH. Ramp up = 1.
> >     10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Continue on error
> >     10/17/2003 12:19:52 PM INFO  - jmeter.threads.JMeterThread: Thread BSH1-1 started
> >     10/17/2003 12:19:52 PM INFO  - jmeter.threads.JMeterThread: Thread BSH1-1 is done
> >     10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Test has ended

> > The log file can be helpful in determining the cause of an error, as JMeter does not interrupt a test to display an error dialogue.

> 2.4.7 Full list of command-line options

> > Invoking JMeter as "jmeter -?" will print a list of all the command-line options. These are shown below.

> >             -h, --help
> >                     print usage information and exit
> >             -v, --version
> >                     print the version information and exit
> >             -p, --propfile {argument}
> >                     the jmeter property file to use
> >             -q, --addprop {argument}
> >                     additional property file(s)
> >             -t, --testfile {argument}
> >                     the jmeter test(.jmx) file to run
> >             -l, --logfile {argument}
> >                     the file to log samples to
> >             -n, --nongui
> >                     run JMeter in nongui mode
> >             -s, --server
> >                     run the JMeter server
> >             -H, --proxyHost {argument}
> >                     Set a proxy server for JMeter to use
> >             -P, --proxyPort {argument}
> >                     Set proxy server port for JMeter to use
> >             -u, --username {argument}
> >                     Set username for proxy server that JMeter is to use
> >             -a, --password {argument}
> >                     Set password for proxy server that JMeter is to use
> >             -J, --jmeterproperty {argument}={value}
> >                     Define additional JMeter properties
> >             -D, --systemproperty {argument}={value}
> >                     Define additional System properties
> >             -S, --systemPropertyFile {filename}
> >                     a property file to be added as System properties
> >             -L, --loglevel {argument}={value}
> >                     Define loglevel: [category=]level
> >                     e.g. jorphan=INFO or jmeter.util=DEBUG
> >             -r, --runremote
> >                     Start remote servers from non-gui mode
> >             -d, --homedir {argument}
> >                     the jmeter home directory to use

2.5 Configuring JMeter

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

> Note: since 2.1.2, you can define additional JMeter properties in the file defined by the JMeter property user.properties which has the default value user.properties . The file will be automatically loaded if it is found in the current directory. Similarly, system.properties is used to update system properties.

> Parameters

> Attribute | Description | Required
> --- | --- | ---
> ssl.provider | You can specify the class for your SSL implementation. If you are using the JSSE from sun, then it is: com.sun.net.ssl.internal.ssl.Provider. JMeter, by default, should provide https support is you are using JDK1.4 or if you use JDK1.3 with the JSSE class jars in your JMeter classpath. | No
> xml.parser | You can specify an implementation as your XML parser. The default value is: org.apache.xerces.parsers.SAXParser | 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 menus. | No
> search_paths | List of paths (separated by ;) that JMeter will search for JMeter add-on classes; for example additional samplers. This is in addition to any jars found in the lib/ext directory. | No
> user.classpath | List of paths that JMeter will search for utility classes. This is in addition to any jars found in the lib directory. | No
> user.properties | Name of file containing additional JMeter properties. These are added after the initial property file, but before the -q and -J options are processed. | No
> system.properties | Name of file containing additional system properties. These are added before the -S and -D options are processed. | No

> See also the comments in the jmeter.properties file for further information on other settings you can change.

Index | Next | Prev

Copyright © 1999-2006, Apache Software Foundation | Updated: $Date: 2006-06-01 19:59:54 +0100 (Thu, 01 Jun 2006) $