Skip to content

Make jmh params configurable via command line args #8305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jack-berg wants to merge 3 commits into
base: main
Choose a base branch
from
+36 −0
Open

Make jmh params configurable via command line args #8305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5157541
Make jmh params configurable via command line args
jack-berg Apr 17, 2026
919cc50
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Apr 21, 2026
49f90a2
Document new jmh params in knowledge base
jack-berg Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions buildSrc/src/main/kotlin/otel.jmh-conventions.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,31 @@ jmh {
includes.add(jmhIncludeSingleClass as String)
}

val jmhFork: String? by project
if (jmhFork != null) {
fork.set(jmhFork!!.toInt())
}

val jmhIterations: String? by project
if (jmhIterations != null) {
iterations.set(jmhIterations!!.toInt())
}

val jmhTime: String? by project
if (jmhTime != null) {
timeOnIteration.set(jmhTime)
}

val jmhWarmupIterations: String? by project
if (jmhWarmupIterations != null) {
warmupIterations.set(jmhWarmupIterations!!.toInt())
}

val jmhWarmup: String? by project
if (jmhWarmup != null) {
warmup.set(jmhWarmup)
}

val testJavaVersion = gradle.startParameter.projectProperties.get("testJavaVersion")?.let(JavaVersion::toVersion)
if (testJavaVersion != null) {
val javaExecutable = javaToolchains.launcherFor {
Expand Down
11 changes: 11 additions & 0 deletions docs/knowledge/other-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ Benchmark sources live in `jmh/` directories within their respective modules.
./gradlew -PjmhIncludeSingleClass=BatchSpanProcessorBenchmark :sdk:trace:jmh
```

The following JMH parameters can be configured via `-P` flags:

| Flag | JMH setting | Example |
|---|---|---|
| `-PjmhIncludeSingleClass=<class>` | Run only this benchmark class | `-PjmhIncludeSingleClass=BatchSpanProcessorBenchmark` |
| `-PjmhFork=<n>` | Number of forks | `-PjmhFork=1` |
| `-PjmhIterations=<n>` | Measurement iterations | `-PjmhIterations=5` |
| `-PjmhTime=<duration>` | Time per measurement iteration | `-PjmhTime=2s` |
| `-PjmhWarmupIterations=<n>` | Warmup iterations | `-PjmhWarmupIterations=3` |
| `-PjmhWarmup=<duration>` | Time per warmup iteration | `-PjmhWarmup=1s` |

## Composite builds

> **No compatibility guarantees**: this process can change at any time. Steps that work for one
Expand Down
Loading