-
Notifications
You must be signed in to change notification settings - Fork 117
Description
I think the docs are slightly misaligned with the new functionality introduced in #2882
Before that changed, naming of performance log was <name_of_test_class>_<test_hash>.log. In other words: the short name was used to name the log file. This is also suggested by the example in the docs (even if it is not explicitely stated that this is the filename format).
Since the change, for parameterized tests, the performance log file is now just <name_of_test_class>.log, as all performance information for different parameters are combined in the same logfile.
I think the name of the log file (and change therein) could be better reflected in the docs. The first time I saw the test hash being omitted, I though it was a bug, but... it's a feature :). The documentation didn't clear it up for me, and also doesn't list the "Changed in ReFrame XYZ" that you usually include (which is extremely useful btw :)).
On a side note: changing this behavior could have breaking effects for people that use visualization tools to visualize there performance results, as these typically make assumptions on the structure of the logs used as input (e.g. everything in one file is one unique test, with parameter combinations being found in <test_name>_<any_hash>.log). It could have been nice to make the combination of logs for different test hashes optional (opt-in or opt-out, either would work to not have to adapt downstream visualization) to provide more stability for people developing or using downstream visualization tools.
Additionally there is another reason why people might prefer the previous structure. That structure (one log file per unique test) made it very easy to visually see if performance was stable over time: all entries in the log file should report the same performance. With the new logging structure, that's not so easy, as running tests with different parameters might be expected to have different performance (e.g. CPU vs GPU based runs).
Metadata
Metadata
Assignees
Labels
Type
Projects
Status