Feature request: benchmark description

[erikvanoosten]

Request

Add a new optional property description to each benchmark. When present, the description is displayed below the benchmark name or below the benchmark graph.

Rationale

If we look for example at https://zio.github.io/zio-kafka/dev/bench/ we see vague benchmark names that are derived from code names. By themselves they make sense, but every time we need to look up what the benchmark actually does.

Without the description, the benchmark result cannot be interpreted and is therefore worthless.

[ktrz]

Hey @erikvanoosten
Thank you for submitting the issue. I need some clarification on what is the exact feature you're asking for.

Do you need to be able to specify additional description param for the benchmark run here. This way way we could display the description under JMH Benchmark in the case of zio-kafka

If you need to have a description for each single benchmark? In that case the JSON output from JMH would need to contain that data and as far as I've seen so far it does not. Is there a way to get that information into JMH output?