Skip to content

[doc] Enhance documentation about performance log directories #1710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 25, 2021
Merged

[doc] Enhance documentation about performance log directories #1710

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5cf72f
add more details about the perflog file
rsarm Jan 22, 2021
c6ffe92
Fine tune documentation about performance logging
Jan 23, 2021
c84ad58
Merge branch 'master' into doc/configure-perflog
Jan 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,10 @@ You can view logger's log level as a general cut off.
For example, if we have set it to ``warning``, no debug or informational messages would ever be printed.

Finally, there is a special set of handlers for handling performance log messages.
These are stored in the ``handlers_perflog`` property.
The performance handler in this example will create a file per test and per system/partition combination and will append the performance data to it every time the test is run.
Notice in the ``format`` property how the message to be logged is structured such that it can be easily parsed from post processing tools.
Performance log messages are generated *only* for `performance tests <tutorial_basics.html#writing-a-performance-test>`__, i.e., tests defining the :attr:`perf_patterns <reframe.core.pipeline.RegressionTest.perf_patterns>` attribute.
The performance log handlers are stored in the ``handlers_perflog`` property.
The ``filelog`` handler used in this example will create a file per test and per system/partition combination (``./<system>/<partition>/<testname>.log``) and will append to it the obtained performance data every time a performance test is run.
Notice how the message to be logged is structured in the ``format`` property, such that it can be easily parsed from post processing tools.
Apart from file logging, ReFrame offers more advanced performance logging capabilities through Syslog and Graylog.


Expand Down