Skip to content

Commit 9399103

Browse files
author
Vasileios Karakasis
authored
Merge pull request #1710 from rsarm/doc/configure-perflog
[doc] Enhance documentation about performance log directories
2 parents 23f896d + c84ad58 commit 9399103

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/configure.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,10 @@ You can view logger's log level as a general cut off.
190190
For example, if we have set it to ``warning``, no debug or informational messages would ever be printed.
191191

192192
Finally, there is a special set of handlers for handling performance log messages.
193-
These are stored in the ``handlers_perflog`` property.
194-
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.
195-
Notice in the ``format`` property how the message to be logged is structured such that it can be easily parsed from post processing tools.
193+
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.
194+
The performance log handlers are stored in the ``handlers_perflog`` property.
195+
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.
196+
Notice how the message to be logged is structured in the ``format`` property, such that it can be easily parsed from post processing tools.
196197
Apart from file logging, ReFrame offers more advanced performance logging capabilities through Syslog and Graylog.
197198

198199

0 commit comments

Comments
 (0)