<?xml version="1.0"?>
<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at
 
       http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->

<!DOCTYPE document[
<!ENTITY sect-num '2'>
]>

<document prev="intro.html" next="build-test-plan.html" date="$Date: 2008-05-08 17:13:16 +0100 (Thu, 08 May 2008) $">

<properties>
  <title>User's Manual: Getting Started</title>
</properties>
<body>

<section name="&sect-num;. Getting Started" anchor="get_started">
<p>The easiest way to begin using JMeter is to first
<a href="http://jakarta.apache.org/site/downloads/index.html">download the latest production release</a> and install it.
The release contains all of the files you need to build and run most types of tests,
e.g. Web (HTTP/HTTPS), FTP, JDBC, LDAP, Java, and JUnit.</p>
<p>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.</p>
<p>
Other software that you may need to download:
<ul>
<li><a href="http://www.beanshell.org/">BeanShell</a> - needed for the BeanShell function and test elements</li>
<li><a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Java Activation Framework</a> - needed for JavaMail</li>
<li><a href="http://java.sun.com/products/javamail/index.jsp">Java Mail</a> - needed for Mail Visualiser, Mail Reader and WebService(SOAP) sampler</li>
<li><a href="http://java.sun.com/products/jms/docs.html">JMS</a> - for JMS samplers</li>
<li><a href="http://java.sun.com/downloads/">General Java download page</a></li>
</ul>
</p>
<note>
See the <a href="#classpath">JMeter Classpath</a> section for details on installing additional jars.
</note>
<p>Next, start JMeter and go through the <a href="build-test-plan.html">Building a Test Plan</a> section
of the User Guide to familiarize yourself with JMeter basics (for example, adding and removing elements).</p>
<p>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
<a href="build-web-test-plan.html">Building a Web Test Plan</a>.
The other specific Test Plan sections are:
<ul>
<li><a href="build-adv-web-test-plan.html">Advanced Web Test Plan</a></li>
<li><a href="build-db-test-plan.html">JDBC</a></li>
<li><a href="build-ftp-test-plan.html">FTP</a></li>
<li><a href="build-jms-point-to-point-test-plan.html">JMS Point-to-Point</a></li>
<li><a href="build-jms-topic-test-plan.html">JMS Topic</a></li>
<li><a href="build-ldap-test-plan.html">LDAP</a></li>
<li><a href="build-ldapext-test-plan.html">LDAP Extended</a></li>
<li><a href="build-ws-test-plan.html">WebServices (SOAP)</a></li>
<li></li>
</ul>
</p>
<p>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.</p>
</section>

<section name="&sect-num;.1 Requirements" anchor="requirements">
<p>JMeter requires your computing environment meets some minimum requirements.</p>

<subsection name="&sect-num;.1.1 Java Version" anchor="java_versions">
<note>JMeter requires a fully compliant JVM 1.4 or higher.  
<br/>
Version 2.2 and later no longer support Java 1.3.
</note>
<p>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.</p>
</subsection>

<subsection name="&sect-num;.1.2 Operating Systems" anchor="os">
<p>JMeter is a 100% Java application and should run correctly on any system
that has a compliant Java implementation.<br/>
JMeter has been tested and works under:
</p>
<ul>
<li>Unix (Solaris, Linux, etc)</li>
<li>Windows (98, NT, XP, etc)</li>
<li>OpenVMS Alpha 7.3+</li>
</ul>
Even if your OS is not listed above, JMeter should run on it provided that the JVM is compliant. 
</subsection>
</section>

<section name="&sect-num;.2 Optional" anchor="optional">
<p>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.</p>


<subsection name="&sect-num;.2.1 Java Compiler" anchor="opt_compiler">
<p>If you want to build the JMeter source or develop JMeter plugins, then you will need a fully compliant JDK 1.4 or higher.</p>
</subsection>

<subsection name="&sect-num;.2.2 SAX XML Parser" anchor="opt_sax">
<p>JMeter comes with Apache's <a href="http://xml.apache.org/">Xerces XML parser</a>. 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 <a href="#classpath">classpath</a>,
and update the <a href="#configuring_jmeter">jmeter.properties</a> file with the full classname of the parser
implementation.</p>
</subsection>

<subsection name="&sect-num;.2.3 Email Support" anchor="opt_email">
<p>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 <a href="#classpath">classpath</a>.</p>
</subsection>

<subsection name="&sect-num;.2.4 SSL Encryption" anchor="opt_ssl">
<p>To test a web server using SSL encryption (HTTPS), JMeter requires that an
implementation of SSL be provided, as is the case with Sun Java 1.4 and above.
If your version of Java does not include SSL support, then it is possible to add an external implementation.
Include the necessary encryption packages in JMeter's <a href="#classpath">classpath</a>.  
Also, update <a href="#configuring_jmeter">system.properties</a> to register the SSL Provider.</p>
<p>
JMeter defaults to protocol level TLS. This can be changed by editting the JMeter property 
"https.default.protocol" in jmeter.properties or user.properties.
</p>
<p><b>JMeter is configured to accept all certificates,
whether trusted or not, regardless of validity periods etc.</b>
This is to allow the maximum flexibility in testing servers.</p>
<p>If the server requires a client certificate, this can be provided.</p>
<p>There is also the <complink name="SSL Manager"/>, for greater control of certificates.</p>
<note>The JMeter proxy server (see below) does not support recording SSL (https).</note>
</subsection>

<subsection name="&sect-num;.2.5 JDBC Driver" anchor="opt_jdbc">
<p>You will need to add your database vendor's JDBC driver to the <a href="#classpath">classpath</a> if you want to do JDBC testing.
Make sure the file is a jar file, not a zip.
</p>
</subsection>

<subsection name="&sect-num;.2.6 Apache SOAP" anchor="opt_soap">
<p>Apache SOAP requires mail.jar and activation.jar. You need to download and copy these two jar files to your <b>jmeter/lib</b> directory. Once the files are in there, JMeter will automatically pick them up.</p>
</subsection>

<subsection name="&sect-num;.2.7 BeanShell" anchor="opt_beanshell">
<p>To run the BeanShell function or any of the BeanShell test elements (sampler, timer etc),
 you need to download the beanshell jar from <a href="http://www.beanshell.org/">http://www.beanshell.org/</a> and copy the jar file to the <b>jmeter/lib directory</b>, where JMeter will automatically pick it up.</p>
</subsection>

<subsection name="&sect-num;.2.7 Libraries for ActiveMQ 3.0" anchor="libraries_activemq">
<p>See <a href="http://activemq.apache.org/initial-configuration.html">http://activemq.apache.org/initial-configuration.html</a>
for details.
</p>
</subsection>

<note>
See the <a href="#classpath">JMeter Classpath</a> section for more details on installing additional jars.
</note>
</section>

<section name="&sect-num;.3 Installation" anchor="install">

<note>
Note: avoid installing JMeter in a path with spaces in the name.  
This causes problems for remote testing.
</note>
<p>We recommend that most users run the <a href="http://jakarta.apache.org/site/downloads/index.html">latest release</a>.</p>
<p>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.</p>
<p>
The installation directory structure should look something like this (for version 2.3.1):
<pre>
jakarta-jmeter-2.3.1
jakarta-jmeter-2.3.1/bin
jakarta-jmeter-2.3.1/docs
jakarta-jmeter-2.3.1/extras
jakarta-jmeter-2.3.1/lib/
jakarta-jmeter-2.3.1/lib/ext
jakarta-jmeter-2.3.1/lib/junit
jakarta-jmeter-2.3.1/printable_docs
</pre>
You can rename the parent directory (e.g. jakarta-jmeter-2.3.1) if you want, but do not change any of the sub-directory names.
The path to the parent directory should not contain any spaces; if it does, then you may have problems running client-server mode.
</p>
</section>

<section name="&sect-num;.4 Running JMeter" anchor="running">
<br/>
<p>To run JMeter, run the jmeter.bat (for Windows) or jmeter (for Unix) file.
These files are found in the bin directory.
After a short pause, the JMeter GUI should appear. 
</p>

<p>
There are some additional scripts in the bin directory that you may find useful.
Windows script files (the .CMD files require Win2K or later):
<ul>
<li>jmeter.bat - run JMeter (in GUI mode by default)</li>
<li>jmeter-n.cmd - drop a JMX file on this to run a non-GUI test</li>
<li>jmeter-n-r.cmd - drop a JMX file on this to run a non-GUI test remotely</li>
<li>jmeter-t.cmd - drop a JMX file on this to load it in GUI mode</li>
<li>jmeter-server.bat - start JMeter in server mode</li>
</ul>
Note: the special name LAST can be used with jmeter-n.cmd, jmeter-t.cmd and jmeter-n-r.cmd
and means the last test plan that was run interactively.
</p>

<p>
Un*x script files; should work on most Linux/Unix systems.
<ul>
<li>jmeter - run JMeter (in GUI mode by default)</li>
<li>jmeter-server - start JMeter in server mode</li>
</ul>
</p>
<subsection name="&sect-num;.4.1 JMeter's Classpath" anchor="classpath">
<p>JMeter automatically finds classes from jars in the following directories:</p>
<ul>
<li>JMETER_HOME/lib - used for utility jars</li>
<li>JMETER_HOME/lib/ext - used for JMeter components and add-ons</li>
</ul>
<p>If you have developed new JMeter components,
then you should jar them and copy the jar into JMeter's <b>lib/ext</b> directory.
JMeter will automatically find JMeter components in any jars found here.
</p>
<p>Support jars (libraries etc) should be placed in the <b>lib</b> directory.</p>

<p>If you don't want to put the extension jars in the <b>lib/ext</b> directory,
then define the property <b>search_paths</b> in jmeter.properties.
Do not use lib/ext for utility jars; it is only intended for JMeter components.
</p>
<p>
Other jars (such as JDBC, JavaMail, Beanshell and any other support libaries needed by the JMeter code)
 should be placed in the <b>lib</b> directory - not the <b>lib/ext</b> directory</p>
<p>Note: JMeter will only find .jar files, not .zip.</p>
<p>You can also install utility Jar files in $JAVA_HOME/jre/lib/ext, or (since 2.1.1) you can set the property <b>user.classpath</b> in jmeter.properties</p>
<p>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.]</p>
</subsection>

<subsection name="&sect-num;.4.2 Using a Proxy Server" anchor="proxy_server">
<p>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:</p>
<p>
-H [proxy server hostname or ip address]<br/>
-P [proxy server port]<br/>
-N [nonproxy hosts] (e.g. *.apache.org|localhost)<br/>
-u [username for proxy authentication - if required]<br/>
-a [password for proxy authentication - if required]<br/>
</p>
<p><b>Example</b>: jmeter -H my.proxy.server -P 8000 -u username -a password -N localhost</p>
<p>Alternatively, you can use --proxyHost, --proxyPort, --username, and --password</p>
<note>JMeter also has its own in-built <complink name="HTTP Proxy Server">HTTP Proxy Server</complink>,
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.</note>
</subsection>

<subsection name="&sect-num;.4.3 Non-GUI Mode (Command Line mode)" anchor="non_gui">
<p>For non-interactive testing, you may choose to run JMeter without the GUI. To do so, use
the following command options</p>
<p>-n This specifies JMeter is to run in non-gui mode</p>
<p>-t [name of JMX file that contains the Test Plan].</p>
<p>-l [name of JTL file to log sample results to].</p>
<p>-r Run the test in the servers specified by the JMeter property "remote_hosts"</p>
<p>-R [list of remote servers] Run the test in the specified remote servers</p>
<p>The script also lets you specify the optional firewall/proxy server information:</p>
<p>-H [proxy server hostname or ip address]<br/>
-P [proxy server port]</p>
<p><b>Example</b>: jmeter -n -t my_test.jmx -l log.jtl -H my.proxy.server -P 8000</p>
</subsection>

<subsection name="&sect-num;.4.4 Server Mode" anchor="server">
<p>For <a href="remote-test.html">distributed testing</a>, run JMeter in server mode on the remote node(s), and then control the server(s) from the GUI.
You can also use non-GUI mode to run remote tests.
To start the server(s), run jmeter-server/jmeter-server.bat on each server host.</p>
<p>The script also lets you specify the optional firewall/proxy server information:</p>
<p>-H [proxy server hostname or ip address]<br/>
-P [proxy server port]</p>
<p><b>Example</b>: jmeter-server -H my.proxy.server -P 8000</p>
<p>If you want the server to exit after a single test has been run, then define the JMeter property server.exitaftertest=true.
</p>
<p>To run the test from the client in non-GUI mode, use the following command:</p>
<pre>
jmeter -n -t testplan.jmx -r [-Gprop=val] [-Z]
where:
-G is used to define JMeter properties to be set in the servers
-X means exit the servers at the end of the test
-Rserver1,server2 - can be used instead of -r to provide a list of servers to start
  Overrides remote_hosts, but does not define the property.
</pre>
</subsection>

<subsection name="&sect-num;.4.5 Overriding Properties Via The Command Line" anchor="override">
<p>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:</p>
<p>-D[prop_name]=[value] - defines a java system property value.</p>
<p>-J[prop name]=[value] - defines a local JMeter property.</p>
<p>-G[prop name]=[value] - defines a JMeter property to be sent to all remote servers.</p>
<p>-L[category]=[priority] - overrides a logging setting, setting a particular category to the given priority level.</p>
<p>The -L flag can also be used without the category name to set the root logging level.</p>
	<p><b>Examples</b>:
<pre>
jmeter -Duser.dir=/home/mstover/jmeter_stuff \
    -Jremote_hosts=127.0.0.1 -Ljmeter.engine=DEBUG

jmeter -LDEBUG</pre>
</p>
<p>
<b>N.B.<br/>
	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.</b>
	</p>
</subsection>
<subsection name="&sect-num;.4.6 Logging and error messages" anchor="logging">
    <note>
    JMeter does not generally use pop-up dialog boxes for errors, as these would interfere with
    running tests. Nor does it report any error for a mis-spelt variable or function; instead the
    reference is just used as is. See <a href="functions.html">Functions and Variables for more information</a>.
    </note>
	<p>If JMeter detects an error during a test, a message will be written to the log file. 
		The log file name is defined in the jmeter.properties file (or using the -j option, see below).
		It defaults to <b>jmeter.log</b>, and will be found in the directory from which JMeter was launched.
		[in JMeter 2.2 and earlier, this was forced to be the JMeter bin directory.]
		</p>
		<p>
		JMeter versions after 2.2 added a new command-line option, -j jmeterlogfile. 
		This is processed after the initial properties file is read,
		and before any further properties are processed. 
		It therefore allows the default of jmeter.log to be overridden.
		The jmeter scripts that take a test plan name as a parameter (e.g. jmeter-n.cmd) have been updated
		to define the log file using the test plan name,
		e.g. for the test plan Test27.jmx the log file is set to Test27.log.
		</p>
		<p>When running on Windows, the file may appear as just <b>jmeter</b> 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...]
		</p>
		<p>As well as recording errors, the jmeter.log file records some information about the test run. For example:</p>
<div overflow="scroll">
<pre>
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 	
</pre>
</div>
<p>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.</p>
</subsection>
<subsection name="&sect-num;.4.7 Full list of command-line options" anchor="options">
<p>Invoking JMeter as "jmeter -?" will print a list of all the command-line options. 
These are shown below.</p>
<pre>
        -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
        -j, --jmeterlogfile {argument}
                the jmeter log file
        -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
        -G, --globalproperty (argument)[=(value)]
                Define Global properties (sent to servers)
                e.g. -Gport=123
                 or -Gglobal.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 (non-GUI only)
                Start remote servers (as defined by the jmeter property remote_hosts)
        -R, --remotestart  server1,... (non-GUI only)
                Start these remote servers (overrides remote_hosts)
        -d, --homedir {argument}
                the jmeter home directory to use
        -X, --remoteexit
                Exit the remote servers at end of test (non-GUI)
</pre>
<p>
Note: the JMeter log file name is formatted as a SimpleDateFormat (applied to the current date) 
if it contains paired single-quotes,  .e.g. 'jmeter_'yyyyMMddHHmmss'.log'
</p>
<p>
If the special name LAST is used for the -t, -j or -l flags, then JMeter takes that to mean the last test plan
that was run in interactive mode.
</p>
</subsection>
</section>


<section name="&sect-num;.5 Configuring JMeter" anchor="configuring_jmeter">
<p>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.
  </p>
  <note>
  Note: since 2.2, you can define additional JMeter properties in the file defined by the
  JMeter property <b>user.properties</b> which has the default value <b>user.properties</b>.
  The file will be automatically loaded if it is found in the current directory
  or if it is found in the JMeter bin directory.
  Similarly, <b>system.properties</b> is used to update system properties.
  </note>
  <properties>
	<property name="ssl.provider">You can specify the class for your SSL
	implementation if you don't want to use the built-in Java implementation.
	</property>
	<property name="xml.parser">You can specify an implementation as your XML
	parser.  The default value is: org.apache.xerces.parsers.SAXParser</property>
  <property name="remote_hosts">Comma-delimited list of remote JMeter hosts (or host:port if required).
	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</property>
  <property name="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.</property>
  <property name="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.
  </property>
  <property name="user.classpath">
  List of paths that JMeter will search for utility classes.
  This is in addition to any jars found in the lib directory.
  </property>
  <property name="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.
  </property>
  <property name="system.properties">
  Name of file containing additional system properties.
  These are added before the -S and -D options are processed.
  </property>
  </properties>
<p><b>
See also the comments in the jmeter.properties, user.properties and system.properties files for further information on other settings you can change.
</b></p>
</section>

</body>
</document>

