Micro-benchmark your ZIO effects!
// build.sbt
libraryDependencies += "dev.koubic" %% "zio-ubench" % "0.2.3"import zio.ubench._
import zio._
import zio.duration._
val io = ZIO.effectTotal {
(0 until 1000000)
.map(_ + 1)
.last
}
val ioDur = io.benchmark()
ioDur.flatMap { d =>
console.putStrLn(s"duration of execution of io: ${d}")
}Outputs:
duration of execution of io: PT0.02105794S
The benchmark() method accepts the parameter that describes how to do the benchmark:
val ioDur = io.benchmark(
Benchmark.untilLocalDurationMin(30)
)This stops the benchmark after the run time of the io was not improved for 30 steps.
We can also require the benchmark to run for at least 1 second:
val ioDur = io.benchmark(
Benchmark.untilLocalDurationMin(30) <& Benchmark.untilTotalDuration(1.second)
)We can also stop the benchmark if NRMSE is low and return the minimal run time observed:
val ioDur = io.benchmark(
(
(Benchmark.untilLocalDurationMin(30) <& Benchmark.untilTotalDuration(1.second)) ||
Benchmark.untilLowNrmse(0.05, 10)
) &> Benchmark.minMeasurementDuration
)We can also preheat the effect by running it for 1 second and then use the minimal run time from the pre-heat phase to calculate the number of repetitions of the effect, so that it runs approximately 50 milliseconds and then benchmark the repeated effect:
val ioDur = io.benchmark(
(
(
(Benchmark.untilLocalDurationMin(30) <& Benchmark.untilTotalDuration(1.second)) ||
Benchmark.untilLowNrmse(0.05, 10)
) &> Benchmark.minMeasurementDuration
).withPreheat(Benchmark.untilTotalDuration(100.millis), 50.millis)
)
See test/scala/example/ directory for examples.
For more details see the scaladoc of the Benchmark class.