Mirror of Apache JMeter
Java HTML XSLT JavaScript CSS Batchfile Other
Latest commit 1e98de4 Mar 20, 2017 @sebbASF sebbASF Typo
git-svn-id: https://svn.apache.org/repos/asf/jmeter/trunk@1787877 13f79535-47bb-0310-9956-ffa450edef68

README.md

Apache JMeter logo

Apache JMeter

What is it?

Apache JMeter is a 100% pure Java application designed to test and measure performance. It may be used as a highly portable server benchmark as well as multi-client load generator.

Apache JMeter features include:

Ability to load and performance test many different server/protocol types:

  • Web - HTTP, HTTPS
  • SOAP / REST
  • FTP
  • Database via JDBC
  • LDAP
  • Message-oriented Middleware (MOM) via JMS
  • Mail - SMTP(S), POP3(S) and IMAP(S)
  • Native commands or shell scripts
  • TCP

Full multi-threading framework allows concurrent sampling by many threads and simultaneous sampling of different functions by separate thread groups. Careful GUI design allows faster Test Plan building and debugging. Caching and offline analysis/replaying of test results.

Highly Extensible core:

  • Pluggable Samplers allow unlimited testing capabilities.
  • Several load statistics may be chosen with pluggable timers.
  • Data analysis and visualization plugins allow great extensibility and personalization.
  • Functions can be used to provide dynamic input to a test or provide data manipulation.
  • Scriptable Samplers (Groovy, BeanShell, BSF- and JSR223- compatible languages)

The Latest Version

Details of the latest version can be found on the JMeter Apache Project web site (http://jmeter.apache.org/).

Requirements

The following requirements exist for running Apache JMeter:

  • Java Interpreter:

    A fully compliant Java 8 (or later) Runtime Environment is required for Apache JMeter to execute. A JDK with keytool utility is better suited for Recording HTTPS websites.

  • Optional jars:

    Some jars are not included with JMeter. If required, these should be downloaded and placed in the lib directory

    • JDBC - available from the database supplier
    • JMS - available from the JMS provider
    • Bouncy Castle - only needed for SMIME Assertion
  • Java Compiler (OPTIONAL):

    A Java compiler is not needed since the distribution includes a precompiled Java binary archive. Note that a compiler is required to build plugins for Apache JMeter.

Installation Instructions

Note that spaces in directory names can cause problems.

  • Release builds

    Unpack the binary archive into a suitable directory structure.

Running JMeter

  1. Change to the bin directory
  2. Run the jmeter (Un*x) or jmeter.bat (Windows) file.

Windows

For Windows there are also some other scripts which you can drag-and-drop a JMX file onto:

  • jmeter-n.cmd - runs the file as a non-GUI test
  • jmeter-n-r.cmd - runs the file as a non-GUI remote (client-server) test
  • jmeter-t.cmd - loads the file ready to run it as a GUI test

Documentation

The documentation available as of the date of this release is also included, in HTML format, in the printable_docs/ directory, and it may be browsed starting from the file called index.html.

Build instructions

Release builds

Unpack the source archive into a suitable directory structure. Most of the 3rd party library files can be extracted from the binary archive by unpacking it into the same directory structure. You can also use Ant to download the required library files:

ant download_jars

Any optional jars (see above) should be placed in lib/opt and/or lib.

Jars in lib/opt will be used for building JMeter and running the unit tests, but won't be used at run-time.

This is useful for testing what happens if the optional jars are not downloaded by other JMeter users.

If you are behind a proxy, you will have to set an environment entry for ant to use the proxy:

export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080 -Dhttp.user=login -Dhttp.pass=xxxxx"

Test builds

JMeter is built using Ant.

Change to the top-level directory and issue the command:

ant download_jars

This only needs to be done once; it will download any missing 3rd party jars.

ant

This will compile the application and enable you to run jmeter from the bin directory.

ant test [-Djava.awt.headless=true]

This will compile and run the unit tests. The optional property definition is required if the system does not have a suitable GUI display.

Developer information

The code is maintained in SVN at https://svn.apache.org/repos/asf/jmeter/trunk

There is a read-only mirror at GitHub: https://github.com/apache/jmeter

Licensing and legal information

For legal and licensing information, please see the following files:

Cryptographic Software Notice

This distribution may include software that has been designed for use with cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included software that may be subject to export controls on cryptographic software:

Apache JMeter interfaces with the Java Secure Socket Extension (JSSE) API to provide

- HTTPS support

Apache JMeter interfaces (via Apache HttpClient3) with the Java Cryptography Extension (JCE) API to provide

- NTLM authentication

Apache JMeter does not include any implementation of JSSE or JCE.

Thank you for using Apache JMeter.