search

louwrentius / fio-plot

Create charts from FIO storage benchmark tool output
BSD 3-Clause "New" or "Revised" License
370 stars 87 forks source link

[feature request] include fio version on graphs #48

Closed sitsofe closed 3 years ago

sitsofe commented 3 years ago

https://github.com/axboe/fio/blob/master/MORAL-LICENSE encourages people publishing benchmarks to mention they used fio and which version it was. Would it be possible for you to add that information to graphs your tool makes? If so would you also consider an opt-out option too? The hope is that it would help people consuming the graphs too (e.g. fio has bugs that get fixed over time so it's good to know the version etc)...

louwrentius commented 3 years ago

Fair enough, should not be too hard.

louwrentius commented 3 years ago

@sitsofe I can add the version to certain graphs, but the line graphs I showed in that bug report I made, can't display the Fio version because that data does not exist in the log files.

The only way to do so, would be to assume that there is an accompanying .json file which name I can predict. This is actually the case when my bench_fio script was used to generate the benchmark data. So I could put that in. But if no predictable .json name is found, the Fio version will be omitted from this particular graph type.

FYI

sitsofe commented 3 years ago

@louwrentius FYI: I think the fio version may turn up in terse logs too but that likely doesn't help you.

I would add the fio version when you know it otherwise leave it out and just mention something like "Data from fio, graphed by fio-plot 1.0.7" (or some better wording :-) when the user doesn't tell you a version. I guess the key will be having an option to manually say the fio version and having an option to disable adding that text entirely...

louwrentius commented 3 years ago

The Fio version is now displayed in all graph types. I've implemented it the 'hard' way as proposed. So if .json files are available, they are processed and the Fio version is shown. If no .json files are found, no version is displayed (it can't). The version can be disabled with --disable-fio-version

This is merged into 'master'.

It looks like this:

Comparing-performance-of-multiple-SSDs_2020-12-13_153207 Comparing-the-performance-of-various-Solid-State-Drives_2020-12-13_153202

I think this closes out the request, feel free to reopen the issue if required.

louwrentius commented 3 years ago

I forgot to implement your proposal to display "Data generated by Fio" if the Fio version is not available.

louwrentius commented 3 years ago

No- json-files-so-no-Fio-version_2020-12-13_154530

sitsofe commented 3 years ago

(I feel slightly sad that when the fio version is available we don't get to see a shout out to fio-plot which is also working hard to produce those graphs... but no matter what you choose to do thanks for considering this change!)