Repository files navigation

Apache JMeter may be used to test performance both on static and dynamic resources, Web dynamic applications.It can be used to simulate a heavy load on a server, group of servers, network or object to test its strength or to analyze overall performance under different load types.

Apache JMeter features include:

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

• Web - HTTP, HTTPS (Java, NodeJS, PHP, ASP.NET,...)
• SOAP / REST Webservices
• 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
• Java Objects

Full featured Test IDE that allows fast Test Planrecording (from Browsers or native applications), building and debugging.

Command-line mode (Non GUI / headless mode) to load test from any Java compatible OS (Linux, Windows, Mac OSX, ...)

A complete andready to present dynamic HTML report

Live reporting into 3rd party databases like InfluxDB or Graphite

Easy correlation through ability to extract data from most popular response formats,HTML,JSON,XML orany textual format

Complete portability and 100% Java purity

Full multi-threading framework allows concurrent sampling by many threadsand simultaneous sampling of different functions by separate thread groups.

Caching and offline analysis/replaying of test results.

Highly Extensible core:

• Pluggable Samplers allow unlimited testing capabilities.
• Scriptable Samplers (JSR223-compatible languages like Groovy)
• Several load statistics may be chosen withpluggable timers.
• Data analysis andvisualization plugins allow great extensibility and personalization.
• Functions can be used to provide dynamic input to a test or provide data manipulation.
• Easy Continuous Integration through 3rd party Open Source libraries for Maven, Graddle and Jenkins

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

The following requirements exist for running Apache JMeter:

• Java Interpreter:

  A fully compliant Java 8 Runtime Environment is requiredfor Apache JMeter to execute. A JDK with keytool utility is better suitedfor Recording HTTPS websites.Java 9 is not yet supported as of version 3.3.

• 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 aprecompiled Java binary archive.Note that a compiler is requiredto build plugins for Apache JMeter.

Note that spaces in directory names can cause problems.

• Release builds

  Unpack the binary archive into a suitable directory structure.

1. Change to thebin directory
2. Run thejmeter (Un*x) orjmeter.bat (Windows) file.

For Windows there are also some other scripts which you can drag-and-dropa 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

The documentation available as of the date of this release isalso included, in HTML format, in theprintable_docs/ directory,and it may be browsed starting from the file calledindex.html.

SeeIssue Tracking

Unpack the source archive into a suitable directory structure.Most of the 3rd party library files can be extracted from the binary archiveby 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 inlib/opt and/orlib.

Jars inlib/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 notdownloaded by other JMeter users.

If you are behind a proxy, you can set a few build properties inbuild-local.properties for ant to use the proxy:

proxy.use=trueproxy.host=proxy.example.invalidproxy.port=8080proxy.user=your_user_nameproxy.pass=your_password

You might also want to skip some tests - that are failing without proper access to the internet - by adding some moreproperties intobuild-local.properties:

skip.bug52310=trueskip.bug60607=trueskip.batchtest_Http4ImplPreemptiveBasicAuth=trueskip.batchtest_SlowCharsFeature=trueskip.batchtest_TestKeepAlive=trueskip.batchtest_ResponseDecompression=trueskip.test_http=trueskip.test_TestDNSCacheManager.testWithCustomResolverAnd1Server=true

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 runjmeter from thebindirectory.

anttest [-Djava.awt.headless=true]

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

Building and contributing is explained in details athttps://jmeter.apache.org/building.html

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

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

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

• LICENSE

• NOTICE

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

The U.S. Government Department of Commerce, Bureau of Industry andSecurity (BIS), has classified this software as Export CommodityControl Number (ECCN) 5D002.C.1, which includes information securitysoftware using or performing cryptographic functions with asymmetricalgorithms. The form and manner of this Apache Software Foundationdistribution makes it eligible for export under the License ExceptionENC Technology Software Unrestricted (TSU) exception (see the BISExport Administration Regulations, Section 740.13) for both objectcode and source code.

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

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

- HTTPS support

Apache JMeter interfaces (via Apache HttpClient4) with theJava 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.