---
title: JMeter
tags: Projects
---

# JMeter
## What is perfomance test?
A non-functional software testing technique that determines how the **speed, response time, stability, reliability and scalability** of an application holds up under a given workload.
## Why do we need perfomance test?
At least one of the following reasons:

* To determine whether the application satisfies performance requirements (for instance, the system should handle up to 1,000 concurrent users).
* To locate computing bottlenecks within an application.
* A bottleneck is a point of congestion in a production system that stops or severely slows the system.
* To establish whether the performance levels claimed by a software vendor are indeed true.
* To compare two or more systems and identify the one that performs best.
* To measure stability under peak traffic events.

## Installation
1. JMeter requires ==Java JDK 8+== to run.
* **Note: Java JDK releases a new version every 6 months and releases a LTS every 2 years**
* The latest LTS version is **Java JDK 21** (shows below), but you can also use any other 8+ version.
* [Java JDK Download Page](https://www.oracle.com/java/technologies/downloads/)
* Here I choose the **.exe** file to download, but you can choose what format you prefer.
* Open the installation file, just use default settings, don't have to change anything, click **next**, **next**, then **close** when finish.

2. For Windows system, click the words with ==the red circle== shown in the screenshot below, to download JMeter zip file.
* [JMeter Download Page](https://jmeter.apache.org/download_jmeter.cgi)
* Don't download it from the **source** section, otherwise you will miss a file called **ApacheJMeter** to run JMeter.
* Unzip the downloaded file, execute **jmeter.bat** in the **\bin** directory, and open the JMeter software, it might take a few seconds.
* YES!! YOU DON'T HAVE TO INSTALL JMETER, JUST UNZIP AND EXECUTE IT.
* Be careful! It has lots of twins also named ==jmeter==, please check the file format.
* Don't close the terminal window.

## Use JMeter to create a test plan.
* When you open JMeter, you will see ==Test Plan== here.
* Right clik on Test Plan -> Add -> Threads (Users) -> Thread Group
* Fill in the information. We just need a name for now.
* We simulate only 1 thread because it's other people's server, that's why we don't modify other information here.
* Now we configure the settings.
* Setup HTTP default request HEADER
* Right click on the **thread group**, here my thread group name is **reqres.in_APIs_testing**, Add -> Config Element -> HTTP Request Defaults
* HTTP Request Defaults is the default setting for every HTTP Request under this thread group.
* 
* Fill in the information.
* We will send JSON in the request body for **POST** APIs later, so we add **HTTP Header Manager**, to add **Content-Type: application/json** in the request header
* Content-Type: application/json indicates that the request body format will be JSON.
* 
* 
* Now let’s add the APIs that we are going to test.
* ==All the APIs we use are from [https://reqres.in/](https://reqres.in/)==
* Right click on the **thread group**, here my thread group name is **reqres.in_APIs_testing**, Add -> Sampler -> HTTP Request
* 
* Fill in the information
* Let's try **register** together.
* 1. Name
* 2. Method and path
* **Register** and **login** are 99.9% **POST** method.
* Of course, check API document from your project.
* 3. Register data
* Let's try **login** together.
* 1. Name
* 2. Method and path
* 3. Login data
* Same work for other APIs.
* Why we don't have to fill in **protocol and server name/IP**?
Because we already did that in **HTTP Request Defaults**.
* **Get** method normally passes API parameters in the url, not in the HTTP request body.
* Get a list of users
* Get a single-user
* Get another single-user
* Delay response example API

## How to see the result and generate a report?
* Commonly we add **View Results Tree** and **Summary Report** to observe the result
* Right click on the **thread group**, here my thread group name is **reqres.in_APIs_testing**, Add -> Listener -> View Results Tree
* Right click on the **thread group**, here my thread group name is **reqres.in_APIs_testing**, Add -> Listener -> Summary Report
* The first time when you want to execute the test flow, but haven't saved the file, JMeter will notify you.
* Then we click the green triangle button to execute the test flow.
* Result Tree page
* Summary Report
* You can also right-click and click on clear to clear the result.
## Want a more beautiful report?
* **After running the test, and having the result values.**
* Click on the **Summary Report** on the left.
* Click on the **Save Table Data** on the bottom.
* Then we can use the **.csv** file that we have just saved for our HTML report. 🥳
* Tools -> Generate HTML report
* Fill in all fields.
* Remember, in the 3rd step, the folder should be empty.
* After filling in all the fields, click on the **Generate report** button.
* You will have the report like this, just open the **index.html** file in the output directory.
* 
* 

## Go further
* In real life, we might also want to
* Simulate more users, you can modify the **Number of Threads (users)**
* Have all the threads running not all at the beginning, but gradually, you can modify **Ramp-up period (seconds)**, it means it will reach the number of threads at this time.
* If you want to run the whole plan more than 1 time, you can modify **Loop Count**.
* You might want to perform "login" with many users using their usernames and passwords, you can save the information in **.csv** file, and insert the file to JMeter.
* And of course, you can edit the script in JMeter to save their **token**s, and use it in the following APIs which need **auth**.
* The last but not the least.
* If we aim to test max 10000 users, we will schedule our testing plan to test different amount of the numbers, for example, test 1000 ppl, 3000 ppl, 5000 ppl, 8000 ppl, and finally 10000 ppl.
* And We can analyse the result, to locate computing bottlenecks within an application.