Skip to content

Commit cc16120

Browse files
committed
Add documentation for check_completion_time
1 parent 93ca17b commit cc16120

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/running.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -840,6 +840,11 @@ All handlers accept the following set of attributes (keys) in their configuratio
840840
* ``format`` (default: ``'%(message)s'``): Format string for the printout of the log record.
841841
ReFrame supports all the `format strings <https://docs.python.org/3.6/library/logging.html#logrecord-attributes>`__ from Python's logging library and provides the following additional ones:
842842

843+
- ``check_completion_time``: A timestamp with the completion time of the regression test.
844+
For the ``slurm`` scheduler, the timestamp relies on job accounting (``sacct`` command) and returns the termination time of the job.
845+
The rest of the schedulers report as completion time the moment the framework realizes the test has finished, as soon as the ``wait`` phase ends.
846+
The accuracy is dependent on the polling rate of the ``wait`` phase and can be lower for tests that take more time.
847+
If a job or process is not yet completed, ``None`` will be printed.
843848
- ``check_environ``: The programming environment a test is currently executing for.
844849
- ``check_info``: Print live information of the currently executing check.
845850
By default this field has the form ``<check_name> on <current_partition> using <current_environment>``.

0 commit comments

Comments
 (0)