jenkinsci / jmh-report-plugin

Visually explore your JMH benchmarks on Jenkins!

Jenkins JMH Report Plugin

Visually explore your JMH benchmarks on Jenkins!

Based on JMH Visualizer.

Given your project runs JMH benchmarks, you can use this plugin to visualize the results of it. The results need to be stored in JSON therefore.

Setup in Jenkins

As a pipeline step

jmhReport 'build/reports/jmh/result.json'

OR

step([$class: 'RunPublisher', resultPath: 'build/reports/jmh/result.json'])

A complete pipeline could look like that:

node {
    checkout([$class: 'GitSCM', branches: [[name: '*/master']], userRemoteConfigs: [[url: 'https://github.com/ben-manes/caffeine.git']]])
    sh './gradlew jmh -PincludePattern=".*DelegationBenchmark.*"'
    jmhReport 'caffeine/build/reports/jmh/results.json'
}

As a post-build action

As a Job-DSL-Plugin

jmhReport { resultPath('build/reports/jmh/result.json') }

A complete job-dsl example could look like that:

job('example-1') {
    steps {
        scm {
            git("https://github.com/ben-manes/caffeine.git", "master")
        }
        shell('./gradlew jmh -PincludePattern=".*DelegationBenchmark.*"')
        publishers {
            jmhReport {
                resultPath('build/reports/jmh/result.json')
            }
        }
    }
}

Building the project

• Setup project for eclipse: mvn -DdownloadSources=true eclipse:eclipse
• Run a Jenkins instance with the plugin deployed
  • mvn hpi:run
  • go to http://127.0.0.1:8080/jenkins

Releasing the project

• (Only on jmh-visualizer update) Copy bundle.js (from jmh-visualizer) into src/main/webapp/
• (Only on major version change) Change version in pom.xml to ${version}-SNAPSHOT
• Test the Plugin in dev mode: mvn hpi:run
• Test the Plugin on a Jenkins instance:
  • Build the HPI: mvn hpi:hpi
  • Download and install Jenkins (https://jenkins.io/download/)
  • Start and stop on a Mac with
    • sudo launchctl load /Library/LaunchDaemons/org.jenkins-ci.plist
    • sudo launchctl unload /Library/LaunchDaemons/org.jenkins-ci.plist
  • Upload the HPI (target/jmh-report.hpi) into the local Jenkins instance
• Commit & Push
• Release: mvn release:prepare release:perform
• Update https://wiki.jenkins.io/display/JENKINS/JMH+Report+Plugin

jmh-report-plugin's Issues

Support Globbing

Hi.
I'm using this plugin to have the jmh report of my project directly
available/rendered within jenkins. Everything works so far in a single
project.

e.g.

steps {
	bash './gradlew jmh'
}
post {
	always {
		jmhReport 'build/reports/jmh/result.json'
	}
}

But when i have a multi-project, I have to define the result file on each module.
My question is, is "globbing" a missing feature?
Or did I misunderstand the README and the class/method

jmh-report-plugin/src/main/java/io/morethan/jenkins/jmhreport/RunPublisher.java

Line 48 in 688739f

public void perform(Run<?, ?> run, FilePath workspace, Launcher launcher, TaskListener listener)

to be able to use globbing/pattern to define more than just one result file.

e.g.

steps {
	bash './gradlew jmh'
}
post {
	always {
		jmhReport '**/build/reports/jmh/result.json'
	}
}

thx
marko

Support Multiproject Reports

Why
I want to use the jmh report plugin on a multi project build.
At the moment, this plugin can handle only one report in a single project. In a multi project env the results will be overwritten by each other.