Gradle-JMH-Report

gradle-jmh-report is a Gradle plugin to manage and visualize the result of your 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 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
• 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 or a simple do-it-your-self script.
• 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