diff --git a/docs/configuration.rst b/docs/configuration.rst index 6b6049f5..faa6472d 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -856,6 +856,65 @@ Description for available ``PRAGMA`` statements and further details. +extractor.*.actions +------------------- +Type + * ``object`` (`pattern` -> `action`) + * ``list`` of ``lists`` with 2 ``strings`` as elements +Example + .. code:: json + + { + "error" : "status |= 1", + "warning:(?i)unable to .+": "exit 127", + "info:Logging in as .+" : "level = debug" + } + + .. code:: json + + [ + ["error" , "status |= 1" ], + ["warning:(?i)unable to .+", "exit 127" ], + ["info:Logging in as .+" , "level = debug"] + ] + +Description + Perform an ``action`` when logging a message matched by ``pattern``. + + ``pattern`` is parsed as severity level (``debug``, ``info``, ``warning``, ``error``, or integer value) + followed by an optional `Python Regular Expression `__ + separated by a colon ``:``. + Using ``*`` as `level` or leaving it empty + matches logging messages of all levels + (e.g. ``*:`` or ``:``). + + ``action`` is parsed as action type + followed by (optional) arguments. + + Supported Action Types: + + ``status``: + | Modify job exit status. + | Expected syntax is `` `` (e.g. ``= 100``). + + Supported operators are + ``=`` (assignment), + ``&`` (bitwise AND), + ``|`` (bitwise OR), + ``^`` (bitwise XOR). + ``level``: + | Modify severity level of the current logging message. + | Can be one of ``debug``, ``info``, ``warning``, ``error`` or an integer value. + ``print`` + Write argument to stdout. + ``restart``: + Restart the current extractor run. + ``wait``: + Stop execution until Enter is pressed. + ``exit``: + Exit the program with the given argument as exit status. + + extractor.*.postprocessors -------------------------- Type