Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jzillmann/gradle-jmh-report
A Gradle plugin building a visual report for JMH benchmarks
https://github.com/jzillmann/gradle-jmh-report
gradle-plugin html-report jmh jmh-benchmarks jmh-visualizer visualization
Last synced: 6 days ago
JSON representation
A Gradle plugin building a visual report for JMH benchmarks
- Host: GitHub
- URL: https://github.com/jzillmann/gradle-jmh-report
- Owner: jzillmann
- License: apache-2.0
- Created: 2016-12-10T12:10:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T19:01:18.000Z (7 months ago)
- Last Synced: 2024-04-19T20:23:17.478Z (7 months ago)
- Topics: gradle-plugin, html-report, jmh, jmh-benchmarks, jmh-visualizer, visualization
- Language: Java
- Size: 4.81 MB
- Stars: 42
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gradle-JMH-Report
**_gradle-jmh-report_** is a [Gradle](http://gradle.org) plugin to manage and visualize the result of your [JMH](http://openjdk.java.net/projects/code-tools/jmh/) benchmarks.
**Note:** **This plugin is not for executing benchmarks**, its for reporting on already executed benchmarks. There are multiple ways how you can setup your JMH benchmark execution in Gradle, i've written in this [blog post](https://blog.morethan.io/jmh-with-gradle-from-easy-to-simple-dc872d57cf7f) about it!
## News
- 2024/04/19 - 0.9.6 Release - On pair with jmh-visualizer-0.9.6 / Couple of bug fixes
- 2018/10/03 - 0.9.0 Release - On pair with jmh-visualizer-0.9.1 / [Couple of smaller features](https://github.com/jzillmann/jmh-visualizer/milestone/6?closed=1)
- 2018/07/29 - 0.8.0 Release - On pair with jmh-visualizer-0.8.2 / Technical update, minor bug fixes
- 2017/10/31 - 0.7.0 Release - On pair with jmh-visualizer-0.7 / Multi Run Support
- 2017/09/04 - 0.6.0 Release - On pair with jmh-visualizer-0.6 / Layout Change
- 2017/07/30 - 0.5.0 Release - On pair with jmh-visualizer-0.5 / Focusing on Benchmarks
- 2017/05/30 - 0.4.0 Release - On pair with jmh-visualizer-0.4 / Report on secondary metrics
- 2017/05/14 - 0.2.0 Release - Integrate https://github.com/jzillmann/jmh-visualizer
- 2016/12/10 - 0.1.0 Release
## Features
- Create a HTML report for one benchmark run
**Wanted:**
- Create a HTML report for multiple benchmark runs
- Archive your benchmark results in a structured way
## Getting Started
- Setup JMH for your project (However you wanne do it, you can use a [plugin](https://github.com/melix/jmh-gradle-plugin) or a simple [do-it-your-self script](exampleProjects/jmh.gradle).
- Add the plugin:
```
plugins {
id "io.morethan.jmhreport" version "0.9.0"
}
```
- Configure the plugin:
```
jmhReport {
jmhResultPath = project.file('build/reports/jmh/result.json')
jmhReportOutput = project.file('build/reports/jmh')
}
```
- Build the report
- Given your benchmarks have been executed and the json result file is present, you can execute ```./gradlew jmhReport``` which will build the html report.
- You can setup a finalizer hook as well: ```tasks.jmh.finalizedBy tasks.jmhReport```. With this, every time you execute your jmh benchmarks, e.g. with _./gradlew jmh_, the _jmhReport_ task will run at the end.
## This is how it looks
## Project Build
- Prepare the project for import into Eclipse: `./gradlew cleanEclipse eclipse`
- Execute the examples: `./gradlew jar ;./gradlew -p exampleProjects/java-benchmarks/ jmh`
- How to publish the Gradle plugin:
- (Optional) Integrate new version of https://github.com/jzillmann/jmh-visualizer
- `npm run providedZip`
- `mv jmh-visualizer.zip ../../eclipse/gradle-jmh-report/src/main/resources/`
- Increase version in _gradle.properties_
- Update _News_ and _Getting Started_ in _README.md_
- Update version number of in build.gradle for all example projects
- Test report: `./gradlew jar ;./gradlew jmh -p exampleProjects/java-benchmarks/ -Pinclude=".*QuickBenchmark.*"`
- Commit & Push
- tag with
- `git tag -a $releaseVersion -m "$releaseVersion release"`
- `git push --tags`
- Execute: `./gradlew publishPlugins`