├── .idea ├── .name ├── copyright │ └── profiles_settings.xml ├── scopes │ └── scope_settings.xml ├── encodings.xml ├── vcs.xml ├── modules.xml ├── artifacts │ └── jmh_profilers.xml ├── libraries │ ├── Maven__junit_junit_4_8_1.xml │ ├── Maven__org_openjdk_jmh_jmh_core_1_3_1.xml │ ├── Maven__net_sf_jopt_simple_jopt_simple_4_6.xml │ ├── Maven__org_apache_commons_commons_math3_3_2.xml │ └── Maven__org_openjdk_jmh_jmh_generator_annprocess_1_3_1.xml ├── misc.xml ├── compiler.xml └── uiDesigner.xml ├── src └── main │ ├── resources │ └── META-INF │ │ └── services │ │ └── org.openjdk.jmh.profile.Profiler │ └── java │ └── profilers │ └── FlightRecordingProfiler.java ├── .travis.yml ├── license ├── jmh-profilers.iml ├── .gitignore ├── README.md └── pom.xml /.idea/.name: -------------------------------------------------------------------------------- 1 | jmh-profilers -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/org.openjdk.jmh.profile.Profiler: -------------------------------------------------------------------------------- 1 | profilers.FlightRecordingProfiler -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | 3 | jdk: 4 | - oraclejdk8 5 | 6 | install: mvn install -Dgpg.skip=true -------------------------------------------------------------------------------- /.idea/copyright/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /.idea/scopes/scope_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /.idea/artifacts/jmh_profilers.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | $PROJECT_DIR$/out/artifacts/jmh_profilers 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/libraries/Maven__junit_junit_4_8_1.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.idea/libraries/Maven__org_openjdk_jmh_jmh_core_1_3_1.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.idea/libraries/Maven__net_sf_jopt_simple_jopt_simple_4_6.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.idea/libraries/Maven__org_apache_commons_commons_math3_3_2.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /.idea/libraries/Maven__org_openjdk_jmh_jmh_generator_annprocess_1_3_1.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) {{{year}}} {{{fullname}}} 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /jmh-profilers.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io 2 | 3 | ### Maven ### 4 | target/ 5 | pom.xml.tag 6 | pom.xml.releaseBackup 7 | pom.xml.versionsBackup 8 | pom.xml.next 9 | release.properties 10 | 11 | 12 | ### Java ### 13 | *.class 14 | 15 | # Mobile Tools for Java (J2ME) 16 | .mtj.tmp/ 17 | 18 | # Package Files # 19 | *.jar 20 | *.war 21 | *.ear 22 | 23 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 24 | hs_err_pid* 25 | 26 | 27 | ### Intellij ### 28 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm 29 | 30 | *.iml 31 | 32 | ## Directory-based project format: 33 | .idea/ 34 | # if you remove the above rule, at least ignore the following: 35 | 36 | # User-specific stuff: 37 | # .idea/workspace.xml 38 | # .idea/tasks.xml 39 | # .idea/dictionaries 40 | 41 | # Sensitive or high-churn files: 42 | # .idea/dataSources.ids 43 | # .idea/dataSources.xml 44 | # .idea/sqlDataSources.xml 45 | # .idea/dynamic.xml 46 | # .idea/uiDesigner.xml 47 | 48 | # Gradle: 49 | # .idea/gradle.xml 50 | # .idea/libraries 51 | 52 | # Mongo Explorer plugin: 53 | # .idea/mongoSettings.xml 54 | 55 | ## File-based project format: 56 | *.ipr 57 | *.iws 58 | 59 | ## Plugin-specific files: 60 | 61 | # IntelliJ 62 | out/ 63 | 64 | # mpeltonen/sbt-idea plugin 65 | .idea_modules/ 66 | 67 | # JIRA plugin 68 | atlassian-ide-plugin.xml 69 | 70 | # Crashlytics plugin (for Android Studio and IntelliJ) 71 | com_crashlytics_export_strings.xml 72 | crashlytics.properties 73 | crashlytics-build.properties 74 | 75 | # Eclipse 76 | .classpath 77 | .project 78 | .settings/ 79 | 80 | # VSCode 81 | .vscode/ 82 | 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## JMH Pluggable Profilers 2 | [![Build Status](https://travis-ci.org/biboudis/jmh-profilers.svg?branch=master)](https://travis-ci.org/biboudis/jmh-profilers) [![Maven Central](https://img.shields.io/maven-central/v/com.github.biboudis/jmh-profilers.svg)](http://search.maven.org/#search|ga|1|a%3A%22jmh-profilers%22) 3 | 4 | Pluggable profilers for [JMH](http://openjdk.java.net/projects/code-tools/jmh/) 5 | that are discovered through SPI (for JMH >= 1.8) when the profiler is present in the classpath. 6 | 7 | ### Profilers List 8 | 1. JFR Profiler: starts automatically [Java Flight Recorder](http://docs.oracle.com/javase/8/docs/technotes/guides/jfr/) 9 | and produces a .jfr file for each benchmark. Each file can be browsed afterwards 10 | via 11 | [Java Mission Control](http://www.oracle.com/technetwork/java/javaseproducts/mission-control/java-mission-control-1998576.html). 12 | This profiler can be considered by JMH as ```supported``` only if the user wants 13 | to explicitly enable the 14 | [commercial features](http://www.oracle.com/technetwork/java/javase/terms/products/index.html). 15 | 16 | ### Installation 17 | _where in the version field you can use the latest one_ 18 | #### Maven 19 | ``` 20 | 21 | com.github.biboudis 22 | jmh-profilers 23 | 0.1.4 24 | 25 | ``` 26 | #### SBT with sbt-jmh plugin 27 | ``` 28 | libraryDependencies ++= Seq("com.github.biboudis" % "jmh-profilers" % "0.1.2") 29 | ``` 30 | 31 | ### Usage 32 | Check if your profiler is discovered through the ```-lprof``` JMH option. This 33 | would append in the list of supported or unsupported profilers an entry of the 34 | following format: 35 | ``` 36 | : . (discovered) 37 | ``` 38 | 39 | ### Contributing 40 | 41 | Sending PRs with improvements, additions with new profilers and opening issues is highly encouraged. 42 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | jar 6 | 7 | com.github.biboudis 8 | jmh-profilers 9 | 0.1.5-SNAPSHOT 10 | 11 | JMH Pluggable Profilers 12 | Pluggable profilers for JMH that are discovered through SPI (for JMH >= 1.2) when the profiler is 13 | present in the classpath. 14 | 15 | https://github.com/biboudis/jmh-profilers 16 | 17 | 18 | 19 | org.openjdk.jmh 20 | jmh-core 21 | 1.18 22 | 23 | 24 | org.openjdk.jmh 25 | jmh-generator-annprocess 26 | 1.18 27 | 28 | 29 | junit 30 | junit 31 | 4.8.1 32 | test 33 | 34 | 35 | 36 | 37 | 38 | 39 | org.apache.maven.plugins 40 | maven-compiler-plugin 41 | 2.3.2 42 | 43 | ${jdk.version} 44 | ${jdk.version} 45 | 46 | 47 | 48 | 49 | maven-gpg-plugin 50 | 1.5 51 | 52 | 53 | sign-artifacts 54 | verify 55 | 56 | sign 57 | 58 | 59 | 60 | 61 | 62 | 63 | org.codehaus.mojo 64 | versions-maven-plugin 65 | 2.1 66 | 67 | false 68 | 69 | 70 | 71 | 72 | maven-deploy-plugin 73 | 2.7 74 | 75 | 76 | 77 | org.apache.maven.plugins 78 | maven-release-plugin 79 | 2.5 80 | 81 | true 82 | false 83 | release 84 | deploy 85 | 86 | 87 | 88 | 89 | maven-source-plugin 90 | 2.4 91 | 92 | 93 | package-sources 94 | 95 | jar 96 | 97 | 98 | 99 | 100 | 101 | 102 | maven-javadoc-plugin 103 | 2.10.1 104 | 105 | 106 | package-javadoc 107 | package 108 | 109 | jar 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | MIT License 121 | http://www.opensource.org/licenses/mit-license.php 122 | 123 | 124 | 125 | 126 | 127 | Aggelos Biboudis 128 | biboudis@gmail.com 129 | 130 | 131 | 132 | 133 | scm:git:git@github.com:biboudis/jmh-profilers.git 134 | scm:git:git@github.com:biboudis/jmh-profilers.git 135 | git@github.com:biboudis/jmh-profilers.git 136 | HEAD 137 | 138 | 139 | 140 | 1.7 141 | 142 | 143 | 144 | 145 | ossrh 146 | https://oss.sonatype.org/content/repositories/snapshots 147 | 148 | 149 | ossrh 150 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 151 | 152 | 153 | 154 | -------------------------------------------------------------------------------- /src/main/java/profilers/FlightRecordingProfiler.java: -------------------------------------------------------------------------------- 1 | package profilers; 2 | 3 | import java.io.File; 4 | import java.io.IOException; 5 | import java.io.PrintWriter; 6 | import java.io.StringWriter; 7 | import java.lang.management.ManagementFactory; 8 | import java.nio.file.Paths; 9 | import java.util.Arrays; 10 | import java.util.Collection; 11 | import java.util.Collections; 12 | import java.util.List; 13 | 14 | import org.openjdk.jmh.infra.BenchmarkParams; 15 | import org.openjdk.jmh.profile.ExternalProfiler; 16 | import org.openjdk.jmh.results.AggregationPolicy; 17 | import org.openjdk.jmh.results.Aggregator; 18 | import org.openjdk.jmh.results.BenchmarkResult; 19 | import org.openjdk.jmh.results.Result; 20 | import org.openjdk.jmh.results.ResultRole; 21 | import org.openjdk.jmh.util.FileUtils; 22 | 23 | // Effectively equivalent to passing jvm args to append for each benchmark. e.g., 24 | // 25 | //@Fork(jvmArgsAppend = 26 | //{"-XX:+UnlockCommercialFeatures", 27 | // "-XX:+FlightRecorder", 28 | // "-XX:StartFlightRecording=duration=60s,filename=./profiling-data.jfr,name=profile,settings=profile", 29 | // "-XX:FlightRecorderOptions=settings=./openjdk/jdk1.8.0/jre/lib/jfr/profile.jfc,samplethreads=true" 30 | //}) 31 | 32 | /** 33 | * The flight recording profiler enables flight recording for benchmarks and starts recording right away. 34 | */ 35 | public class FlightRecordingProfiler implements ExternalProfiler { 36 | 37 | private String startFlightRecordingOptions = "duration=60s,name=profile,settings=profile,"; 38 | private String flightRecorderOptions = "samplethreads=true,"; 39 | 40 | /** 41 | * Directory to contain all generated reports. 42 | */ 43 | private static final String SAVE_FLIGHT_OUTPUT_TO = System.getProperty("jmh.jfr.saveTo", "."); 44 | 45 | /** 46 | * Temporary location to record data 47 | */ 48 | private final String jfrData; 49 | 50 | /** 51 | * Holds whether recording is supported (checking the existence of the needed unlocking flag) 52 | */ 53 | private static final boolean IS_SUPPORTED; 54 | 55 | static { 56 | IS_SUPPORTED = ManagementFactory.getRuntimeMXBean().getInputArguments().contains("-XX:+UnlockCommercialFeatures"); 57 | } 58 | 59 | public FlightRecordingProfiler() throws IOException { 60 | jfrData = FileUtils.tempFile("jfrData").getAbsolutePath(); 61 | } 62 | 63 | @Override 64 | public Collection addJVMInvokeOptions(BenchmarkParams params) { 65 | return Collections.emptyList(); 66 | } 67 | 68 | @Override 69 | public Collection addJVMOptions(BenchmarkParams params) { 70 | 71 | startFlightRecordingOptions += "filename=" + jfrData; 72 | String jfcPath = Paths.get(params.getJvm()).resolve("../../lib/jfr/profile.jfc").normalize().toAbsolutePath().toString(); 73 | flightRecorderOptions += ",settings=" + jfcPath; 74 | 75 | return Arrays.asList( 76 | "-XX:+FlightRecorder", 77 | "-XX:StartFlightRecording=" + startFlightRecordingOptions, 78 | "-XX:FlightRecorderOptions=" + flightRecorderOptions); 79 | } 80 | 81 | @Override 82 | public void beforeTrial(BenchmarkParams benchmarkParams) { 83 | 84 | } 85 | 86 | static int currentId; 87 | 88 | @Override 89 | public Collection afterTrial(BenchmarkResult benchmarkResult, long l, File stdOut, File stdErr) { 90 | String target = Paths.get(SAVE_FLIGHT_OUTPUT_TO).resolve(benchmarkResult.getParams().getBenchmark() + "-" + currentId++ + ".jfr").toAbsolutePath().toString(); 91 | 92 | StringWriter sw = new StringWriter(); 93 | PrintWriter pw = new PrintWriter(sw); 94 | 95 | try { 96 | FileUtils.copy(jfrData, target); 97 | pw.println("Flight Recording output saved to " + target); 98 | } catch (IOException e) { 99 | e.printStackTrace(); 100 | pw.println("Unable to save flight output to " + target); 101 | pw.println("Did you miss the system property: -Djmh.jfr.saveTo ?"); 102 | } 103 | 104 | pw.flush(); 105 | pw.close(); 106 | 107 | NoResult r = new NoResult(sw.toString()); 108 | 109 | return Collections.singleton(r); 110 | } 111 | 112 | @Override 113 | public boolean allowPrintOut() { 114 | return true; 115 | } 116 | 117 | @Override 118 | public boolean allowPrintErr() { 119 | return false; 120 | } 121 | 122 | 123 | public boolean checkSupport(List msgs) { 124 | msgs.add("Commercial features of the JVM need to be enabled for this profiler."); 125 | return IS_SUPPORTED; 126 | } 127 | 128 | 129 | public String label() { 130 | return "jfr"; 131 | } 132 | 133 | @Override 134 | public String getDescription() { 135 | return "Java Flight Recording profiler runs for every benchmark."; 136 | } 137 | 138 | private class NoResult extends Result { 139 | private final String output; 140 | 141 | public NoResult(String output) { 142 | super(ResultRole.SECONDARY, "JFR", of(Double.NaN), "N/A", AggregationPolicy.SUM); 143 | 144 | this.output = output; 145 | } 146 | 147 | @Override 148 | protected Aggregator getThreadAggregator() { 149 | return new NoResultAggregator(); 150 | } 151 | 152 | @Override 153 | protected Aggregator getIterationAggregator() { 154 | return new NoResultAggregator(); 155 | } 156 | 157 | @Override 158 | public String extendedInfo() { 159 | return "JFR Messages:\n--------------------------------------------\n" + output; 160 | } 161 | 162 | private class NoResultAggregator implements Aggregator { 163 | @Override 164 | public NoResult aggregate(Collection results) { 165 | String output = ""; 166 | for (NoResult r : results) { 167 | output += r.output; 168 | } 169 | return new NoResult(output); 170 | } 171 | } 172 | } 173 | } 174 | -------------------------------------------------------------------------------- /.idea/uiDesigner.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | --------------------------------------------------------------------------------