miguelacaro / jtl-reporter

JtlReporter is an online application that allows users to generate beautiful, customizable and easy to understand performance reports from JMeter(Taurus), Locust, and other tools.

JtlReporter

jtl-reporter-showcase.mov

Description

Online reporting application to generate reports from JMeter(Taurus), Locust and other tools by either uploading JTL(csv) file or streaming data from the test run continuously. JtlReporter's main objective is to help you to understand your performance reports better and to spot performance regression.

Features

• Detailed performance report
• Test run comparison
• Performance regression alerts
• Performance insights
• and more.

Used By

Installation steps

1. Install Docker (Engine, Compose)
2. Clone this repository and navigate into cloned folder
3. Deploy JtlReporter using docker-compose within the same folder

$ docker-compose up -d

4. Open in your browser IP address of deployed environment at port 2020

$ http://IP_ADDRESS:2020

Documentation 📖

For additional information please refer to the documentation.

Analytics

Currently, the following metrics are collected:

• every 6 hours the backend application sends an event that the instance is alive
• report processing is finished
• the number of labels and duration of the test run

If you don't want the analytics to be used, you can set OPT_OUT_ANALYTICS to true for backend service. Mixpanel service is used for storing the data.

Repositories structure

JtlReporter consists of the following parts:

• backend
• frontend
• listener
• scheduler
• docs

Screenshot

License

Jtl Reporter is GNU Affero General Public License v3.0 licensed (frontend, backend and listener).

This repository is MIT licensed.