Skip to content
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.

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

chore: clarify the JMH Readme #1025

Merged
merged 6 commits into from
Jan 23, 2024
Merged
Changes from all commits
Commits
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
18 changes: 14 additions & 4 deletions bench-jmh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,22 @@ This subproject contains some microbenchmarks excercising key parts of Apache Pe
own jmh module)


You can run them like:
Pekko uses [sbt-jmh](https://github.com/sbt/sbt-jmh) to integrate [Java Microbenchmark Harness](https://github.com/openjdk/jmh). You can run them like:

project bench-jmh
jmh:run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark
```shell
sbt shell
pekko > project bench-jmh
sbt:bench-jmh> Jmh/run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark
```

Use 'jmh:run -h' to get an overview of the available options.
or execute in one-line command

```shell
sbt bench-jmh/Jmh/run -i 3 -wi 3 -f 1 .*ActorCreationBenchmark
```


Use 'Jmh/run -h' to get an overview of the available options.

Some potentially out of date resources for writing JMH benchmarks:

Expand Down