File: immark-use-markflag.rst

package info (click to toggle)
rsyslog 8.2512.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • 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 (49 lines) | stat: -rw-r--r-- 1,121 bytes parent folder | download
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
.. _param-immark-use-markflag:
.. _immark.parameter.module.use-markflag:

use.markFlag
=============

.. index::
   single: immark; use.markFlag
   single: use.markFlag

.. summary-start

Controls whether emitted mark messages carry the ``MARK`` flag bit.

.. summary-end

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

:Name: use.markFlag
:Scope: module
:Type: boolean
:Default: module=on
:Required?: no
:Introduced: 8.2012.0

Description
-----------
When enabled, immark tags generated messages with the ``MARK`` flag.
This allows actions to filter or suppress them via settings such as the
``action.writeAllMarkMessages`` parameter in
:doc:`../../configuration/actions`. Disable the flag when mark
messages should be treated exactly like ordinary log entries.

Module usage
------------
.. _immark.parameter.module.use-markflag-usage:

.. code-block:: rsyslog

   module(load="immark" use.markFlag="off")

See also
--------

.. seealso::

   * :ref:`param-immark-interval`
   * :doc:`../../configuration/modules/immark`
   * ``action.writeAllMarkMessages`` in :doc:`../../configuration/actions`