idea-jmh-plugin

When viewing benchmark results in the plugin, the output is presented in a tabular format similar to the JMH command line. The columns represent:

• Benchmark: The name of the benchmark method.
• Mode: The JMH measurement mode (e.g., thrpt, avgt, sample, ss).
• Samples: The number of samples collected.
• Score-Idea: The result calculated by the IntelliJ IDEA plugin.
• Score-Term: The result from the standard JMH terminal/command line execution.
• (MAX - MIN)/MAX: The relative difference between the maximum and minimum scores.
• Units: The measurement units (e.g., ops/s, us/op, ops/us).

Benchmark             Mode   Samples   Score-Idea   Score-Term  (MAX - MIN)/MAX     Units
measureThroughput    thrpt         5        9.969        9.926            0.004     ops/s
measureAvgTime        avgt         5   100228.545   100779.818            0.005     us/op

The plugin allows you to interact with JMH benchmarks using standard IntelliJ IDEA actions, similar to how you use JUnit.

Generate a new benchmark method

To create a new @Benchmark method:

1. Right-click in the editor pane and select Generate micro benchmark.
2. Alternatively, use the Generate... action via keyboard shortcuts:
   • Windows/Linux: Alt+Insert
   • macOS: Ctrl + N

Run benchmarks

• Run a single method: Place your cursor on the @Benchmark method declaration and press Ctrl + Shift + F10.
• Run all benchmarks in a class: Place your cursor on the class declaration and press Ctrl + Shift + F10.

Managing Run Configurations

Invoking the Run action creates a new run configuration with default JMH parameters.

• To edit a specific run: Edit the generated run configuration in the Run/Debug Configurations dialog.
• To edit defaults for all future benchmarks: Modify the JMH run configuration template.

// Example of a benchmark method target
@Benchmark
public void myBenchmarkMethod() {
    // ...
}