File: immark-interval.rst

package info (click to toggle)
rsyslog 8.2512.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 30,464 kB
  • sloc: ansic: 123,809; sh: 42,109; makefile: 5,962; javascript: 1,842; python: 1,222; lex: 607; yacc: 193; perl: 162; sql: 103; tcl: 9; ruby: 2
file content (52 lines) | stat: -rw-r--r-- 1,052 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. _param-immark-interval:
.. _immark.parameter.module.interval:

interval
========

.. index::
   single: immark; interval
   single: interval

.. summary-start

Specifies how often immark injects a mark message, in seconds.

.. summary-end

This parameter applies to :doc:`../../configuration/modules/immark`.

:Name: interval
:Scope: module
:Type: integer (seconds)
:Default: module=1200 (seconds)
:Required?: no
:Introduced: 3.0.0

Module usage
------------
.. _immark.parameter.module.interval-usage:

.. code-block:: rsyslog

   module(load="immark" interval="1200")

Legacy names (for reference)
----------------------------
Historic names/directives for compatibility. Do not use in new configs.

.. _immark.parameter.legacy.markmessageperiod:

- ``$MarkMessagePeriod`` — maps to interval (status: legacy)

.. index::
   single: immark; $MarkMessagePeriod
   single: $MarkMessagePeriod

See also
--------

.. seealso::

   * ``action.writeAllMarkMessages`` in :doc:`../../configuration/actions`
   * :doc:`../../configuration/modules/immark`