Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benc-uk/locust-reporter
Generate HTML reports from Locust load test output
https://github.com/benc-uk/locust-reporter
golang load-testing locustio reporting
Last synced: 28 days ago
JSON representation
Generate HTML reports from Locust load test output
- Host: GitHub
- URL: https://github.com/benc-uk/locust-reporter
- Owner: benc-uk
- License: mit
- Archived: true
- Created: 2021-01-20T17:13:28.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-24T18:03:36.000Z (almost 4 years ago)
- Last Synced: 2024-08-04T02:08:00.985Z (4 months ago)
- Topics: golang, load-testing, locustio, reporting
- Language: Go
- Homepage:
- Size: 71.3 KB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-locust - locust-reporter - Generate HTML reports from Locust load test output. (Tools / Reporting)
README
# Locust HTML Report Converter
Simple Go command line application to convert the results of a Locust load test into a HTML report.
[Locust is a developer focused load testing tool](https://locust.io/)
The report will show three main sets of data:
- Summary statistics for all requests
- History data, with a range of metrics charted over the lifetime of the load test
- List of failures by request
This project uses Go templates, [Sprig](http://masterminds.github.io/sprig/) and [Packr](https://github.com/gobuffalo/packr)
# Getting Started
## Installing
Install with `go get`
```bash
go get -u github.com/benc-uk/locust-reporter/cmd/locust-reporter
```
This will install the binary into `$GOPATH/bin/locust-reporter`, ensure this is in your path
Or download a pre-compiled binary (Linux x64)
```bash
wget https://github.com/benc-uk/locust-reporter/releases/download/v1.2.2/locust-reporter
```
## Usage
The command takes the following arguments:
- `-dir` - The input directory, which contains the three Locust CSV files. Default is current directory.
- `-prefix` - The prefix of the CSV files, **required parameter**
- `-outfile` - The output HTML file, which will be created or overwritten. Default is `out.html`
- `-failures` - Include log of failures in the report, can result in very large output. Default is `false`
Example
```bash
./locust-reporter -help
╔════════════════════════════════════════════════╗
║ 🦗 Locust HTML Report Converter 📜 v1.2.2 ║
╚════════════════════════════════════════════════╝
-dir string
Directory holding input Locust CSV files (default ".")
-failures
Include failures in report, can result in very large output
-outfile string
Output HTML filename (default "./out.html")
-prefix string
Prefix for CSV files, required
```
# Building & Running
Makefile reference
```txt
build Build binary executable, into bin directory
clean Clean up
help This help message :)
lint-fix Lint & format, will try to fix errors and modify code
lint Lint & format, will not fix but sets exit code on error
run Run locally
```
# Screenshots
# Known Issues
A very long test with high number of data points may take some processing to display
# Change Log
See [complete change log](./CHANGELOG.md)
# License
This project uses the MIT software license. See [full license file](./LICENSE)