Skip to content

Commit 03d778e

Browse files
author
Vasileios Karakasis
committed
Update documentation
1 parent 62998c8 commit 03d778e

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/config_reference.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -695,12 +695,8 @@ All logging handlers share the following set of common attributes:
695695
If specific formatting is desired, the ``check_job_completion_time`` should be used instead.
696696
- ``%(check_name)s``: The name of the regression test on behalf of which ReFrame is currently executing.
697697
If ReFrame is not executing in the context of a regression test, ``reframe`` will be printed instead.
698-
- ``%(check_num_tasks)s``: The number of tasks assigned to the regression test.
699-
- ``%(check_outputdir)s``: The output directory associated with the currently executing test.
700698
- ``%(check_partition)s``: The system partition where this test is currently executing.
701-
- ``%(check_stagedir)s``: The stage directory associated with the currently executing test.
702699
- ``%(check_system)s``: The system where this test is currently executing.
703-
- ``%(check_tags)s``: The tags associated with this test.
704700
- ``%(check_perf_lower_thres)s``: The lower threshold of the performance difference from the reference value expressed as a fractional value.
705701
See the :attr:`reframe.core.pipeline.RegressionTest.reference` attribute of regression tests for more details.
706702
- ``%(check_perf_ref)s``: The reference performance value of a certain performance variable.
@@ -709,11 +705,20 @@ All logging handlers share the following set of common attributes:
709705
See the :attr:`reframe.core.pipeline.RegressionTest.reference` attribute of regression tests for more details.
710706
- ``%(check_perf_value)s``: The performance value obtained for a certain performance variable.
711707
- ``%(check_perf_var)s``: The name of the `performance variable <tutorial_basic.html#writing-a-performance-test>`__ being logged.
708+
- ``%(check_ATTR)s``: This will log the value of the attribute ``ATTR`` of the currently executing regression test.
709+
Mappings will be logged as ``k1=v1,k2=v2,..`` and all other iterables, except strings, will be logged as comma-separated lists.
710+
If ``ATTR`` is not an attribute of the test, ``%(check_ATTR)s`` will be logged as ``<undefined>``.
711+
This allows users to log arbitrary attributes of their tests.
712+
For the complete list of test attributes, please refer to :doc:`regression_test_api`.
712713
- ``%(osuser)s``: The name of the OS user running ReFrame.
713714
- ``%(osgroup)s``: The name of the OS group running ReFrame.
714715
- ``%(version)s``: The ReFrame version.
715716

716717

718+
.. versionadded:: 3.3
719+
The ability to log arbitrary test attributes was added.
720+
721+
717722
.. js:attribute:: .logging[].handlers[].datefmt
718723

719724
.. object:: .logging[].handlers_perflog[].datefmt

0 commit comments

Comments
 (0)