diff options
Diffstat (limited to '')
| -rw-r--r-- | source/configuration/modules/immark.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/source/configuration/modules/immark.rst b/source/configuration/modules/immark.rst new file mode 100644 index 0000000..cbae437 --- /dev/null +++ b/source/configuration/modules/immark.rst @@ -0,0 +1,41 @@ +********************************** +immark: Mark Message Input Module +********************************** + +=========================== =========================================================================== +**Module Name:** **immark** +**Author:** `Rainer Gerhards <http://www.gerhards.net/rainer>`_ <rgerhards@adiscon.com> +=========================== =========================================================================== + +Purpose +======= + +This module provides the ability to inject periodic "mark" messages to +the input of rsyslog. This is useful to allow for verification that +the logging system is functioning. + +Configuration Parameters +======================== + +.. note:: + + Parameter names are case-insensitive. + +Module Parameters +----------------- + +interval +^^^^^^^^ + +.. csv-table:: + :header: "type", "default", "max", "mandatory", "|FmtObsoleteName| directive" + :widths: auto + :class: parameter-table + + "integer", "1200", "", "no", "``$MarkMessagePeriod``" + +Specifies the mark message injection interval in seconds. + +.. seealso:: + + The Action Parameter ``action.writeAllMarkMessages`` in :doc:`../actions`. |