You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config_reference.rst
+6-28Lines changed: 6 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Even if a configuration object contains a list of other objects, this is not ref
15
15
For example, by ``systems.partitions.name`` we designate the ``name`` property of any partition object inside the ``partitions`` property of any system object inside the top level ``systems`` object.
16
16
If we were to use indices, that would be rewritten as ``systems[i].partitions[j].name`` where ``i`` indexes the systems and ``j`` indexes the partitions of the i-th system.
17
17
For cases, where the objects in a list are not homogeneous, e.g., the logging handlers, we surround the object type with ``..``.
18
-
For example, the ``logging.handlers..filelog..name`` syntax designates the ``name`` attribute of the ``filelog`` logging handler.
18
+
For example, the ``logging.handlers_perflog..filelog..name`` syntax designates the ``name`` attribute of the ``filelog`` logging handler.
This is a directory prefix (usually dynamic), appended to the :attr:`~config.logging.handlers..filelog..basedir`, where the performance logs of a test will be stored.
1157
+
This is a directory prefix (usually dynamic), appended to the :attr:`~config.logging.handlers_perflog..filelog..basedir`, where the performance logs of a test will be stored.
1162
1158
This attribute accepts any of the check-specific `formatting placeholders <#config.logging.handlers_perflog.format>`__.
1163
1159
This allows to create dynamic paths based on the current system, partition and/or programming environment a test executes with.
1164
1160
For example, a value of ``%(check_system)s/%(check_partition)s`` would generate the following structure of performance log files:
@@ -1177,8 +1173,6 @@ The additional properties for the ``filelog`` handler are the following:
A callable for converting the log record into JSON.
@@ -1402,8 +1380,8 @@ This handler transmits the whole log record, meaning that all the information wi
1402
1380
:arg record: The prepared log record.
1403
1381
The log record is a simple Python object with all the attributes listed in :attr:`~config.logging.handlers.format`, as well as all the default Python `log record <https://docs.python.org/3.8/library/logging.html#logrecord-attributes>`__ attributes.
1404
1382
In addition to those, there is also the special :attr:`__rfm_check__` attribute that contains a reference to the actual test for which the performance is being logged.
1405
-
:arg extras: Any extra attributes specified in :attr:`~config.logging.handlers..httpjson..extras`.
1406
-
:arg ignore_keys: The set of keys specified in :attr:`~config.logging.handlers..httpjson..ignore_keys`.
1383
+
:arg extras: Any extra attributes specified in :attr:`~config.logging.handlers_perflog..httpjson..extras`.
1384
+
:arg ignore_keys: The set of keys specified in :attr:`~config.logging.handlers_perflog..httpjson..ignore_keys`.
1407
1385
ReFrame always adds the default Python log record attributes in this set.
1408
1386
:returns: A string representation of the JSON record to be sent to the server or :obj:`None` if the record should not be sent to the server.
0 commit comments