Building JMeterBefore you can compile JMeter, you will need a few things:
- a Java 8 compatible JDK (Java Development Kit)
- Optional: Gradle installation
- the JMeter sources as shown in the next section
Acquiring the source
The official source releases of Apache JMeter can be downloaded from download page.
Compiling and packaging JMeter using Gradle
JMeter can be built entirely using Gradle. The basic command is:
See the list of available tasks via ./gradlew tasks (or ./gradlew tasks --all) for the other tasks that can be used. More detailed information about the available tasks can be found in gradle.md.
Opening project via IntelliJ IDEA
You require IntelliJ 2018.3.1 or newer.
- Open the build.gradle.kts file with IntelliJ IDEA and choose "Open as Project"
- Make sure "Create separate module per source set" is selected
- Make sure "Use default gradle wrapper" is selected
- In the "File already exists" dialogue, choose "Yes" to overwrite
- In the "Open Project" dialogue, choose "Delete Existing Project and Import"
Compiling and packaging JMeter using Eclipse
Option 1 : Importing Eclipse project via Eclipse's "import Gradle project" wizardRecent Eclipse versions can import Gradle projects automatically, so use Then choose and proceed with the import.
Option 2 : Setting up Eclipse project with Gradle taskOnce you have downloaded the sources, you can setup the Eclipse project by running:
./gradlew eclipseYou can then import the project using and select the folder containing JMeter sources.
Contributing to JMeter
We love contribution
We are very grateful to you if you take some time to contribute to the project.
If you have some time to spend on the project you can pick existing enhancement or bug from Issues page.
You can also contribute to translation, see JMeter Localisation (Translator's Guide).
Submitting a patch
If you want to contribute to JMeter for a bug fix or enhancement, here is the procedure to follow:
Check your patch
Before submitting your patch ensure you do the following:
Check that patch compiles and follows Tab space policy by running:
Check that patch does not break JUnit tests by running:
Create a PR using GIT
- Open a bugzilla issue, see Issues page
- Fork Apache JMeter mirror
- Clone your forked repository locally :
git clone https://github.com/yourid/jmeter/
- Create a branch using for example bugzilla id:
git branch BUGID
- Checkout the new branch :
git checkout BUGID
- commit your fix there :
git commit -m 'Fix to BUGID' list of files
- Please avoid creating merge commits in the PR. We embrace small changes, and merge commits are harder to review
- Add JMeter repository as upstream :
git remote add upstream http://www.github.com/apache/jmeter
- push it :
git push origin BUGID
- Create a PR and link it in the bugzilla issue
- Or create a diff and add as attachment to bugzilla issue
git diff > BUGID.patch
It is recommended to follow that configuration by appropriate settings of core.autocrlf. For Windows
git config --global core.autocrlf true, and for macOS and GNU/Linux set
git config --global core.autocrlf inputGit will automatically recognize text files in the repository thanks to .gitattributes, and Git will convert line endings for text files to the appropriate platform-native format (according to core.autocrlf)
Certain files (e.g. *.sh or *.bat) have predefined end of line policy no matter the configuration of the developer workstation.
Create a PR using Patch
- Open a bugzilla issue, see Issues page
- Checkout Apache JMeter source
- Code your fix
- Create your patch by Right clicking on Eclipse project and select
- Attach your patch to the bugzilla issue
Automated (nightly) builds
As part of the development process, the JMeter project has access to various Continuous Integration (CI) server builds. The build output can be useful for testing recent changes to the code-base.
Please note that the builds have not undergone any QA and should only be used for development testing. For further information, see the Nightly builds for developers page.
There is no need to build JMeter if you just want to build an add-on. Just download the binary archive and add the jars to the classpath or use Maven artifacts to build your add-ons. You may want to also download the source so it can be used by the IDE.
See the extras/addons* files in the source tree for some suggestions