File: mmjsonparse-userawmsg.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 (48 lines) | stat: -rw-r--r-- 984 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
.. _param-mmjsonparse-userawmsg:
.. _mmjsonparse.parameter.input.userawmsg:

useRawMsg
=========

.. index::
   single: mmjsonparse; useRawMsg
   single: useRawMsg
   single: mmjsonparse; userawmsg
   single: userawmsg

.. summary-start

Controls whether parsing operates on the raw message or only the MSG part.

.. summary-end

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

:Name: useRawMsg
:Scope: input
:Type: boolean
:Default: off
:Required?: no
:Introduced: 6.6.0

Description
-----------
Specifies if the raw message should be used for parsing (``on``) or just
the MSG part of the message (``off``).

Notes
-----
- Older documentation referred to this boolean setting as ``binary``.

Input usage
-----------
.. _mmjsonparse.parameter.input.userawmsg-usage:

.. code-block:: rsyslog

   action(type="mmjsonparse" useRawMsg="on")

See also
--------
See also the :doc:`main mmjsonparse module documentation
<../../configuration/modules/mmjsonparse>`.