bencheeorg / benchee

Easy and extensible benchmarking in Elixir providing you with lots of statistics!
MIT License
1.41k stars 66 forks source link

Suggestion: Option to kill long-running scenarios early #337

Open Qqwy opened 3 years ago

Qqwy commented 3 years ago

The case where we have a couple of different implementations and we want to test them on small, medium, large and super-large inputs is rather common. Often, we refer to some kind of 'simple' structure as baseline, and want to benchmark a more clever 'complex' structure.

As a simple example, consider benchmarking element-access of a list using Enum.fetch(list, index) to that of :array.get(array, index).

For small inputs, the simple structure might run fast enough (and because of its simplicity, it might actually be faster than the complex structure). However, for larger inputs it will slow down dramatically. While this is nice to show in a graph, at some point we reach a problem:

The only way to resolve this issue right now is to:

  1. Run the benchmark, keeping a close eye.
  2. If it seems to take rather long, interrupt it manually and remove the input case where the benchmarks started hanging
  3. Repeat from (1) until the benchmark actually completes.

An additional drawback is that we have now removed the large inputs for all implementations. This means that if we have multiple 'clever' implementations, we can no longer see how they compare between them for large inputs unless we create another separate benchmark where the simple implementation is missing.


Proposal: Add an option to stop a benchmark scenario if its time to complete is dis-proportionally long w.r.t. the estimated running time. For instance, if time: 5s, we might stop any benchmark scenario where a single run already takes longer than 5s to complete.

devonestes commented 3 years ago

This sounds like adding a timeout configuration to a scenario, which does seem like a reasonable thing to do to me. It's also super easy to implement. If you want to give that a try I'd be more than happy to review a PR and help in that way. I could even put together something myself at one point, but I won't have time for that for a bit.

josevalim commented 2 years ago

We can also support trap signals from recent Elixir versions. So if someone presses Cmd+\\ or similar, you abort it. But I think this particular command also shuts down the VM. :D