File: mmjsonparse-allow_trailing.rst

package info (click to toggle)
rsyslog 8.2512.0-3
  • 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 (53 lines) | stat: -rw-r--r-- 1,509 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
50
51
52
53
.. _param-mmjsonparse-allow_trailing:
.. _mmjsonparse.parameter.allow_trailing:

allow_trailing
==============

.. index::
   single: mmjsonparse; allow_trailing
   single: allow_trailing
   single: trailing data

.. summary-start

Whether to allow non-whitespace data after the JSON object in find-json mode.

.. summary-end

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

:Name: allow_trailing
:Scope: action
:Type: boolean
:Default: on
:Required?: no
:Introduced: 8.2506.0

Description
-----------
Controls whether trailing non-whitespace characters are permitted after the parsed JSON object in find-json mode.

- **on** (default): Allow trailing data after the JSON object. The JSON portion will be parsed and the trailing content ignored.
- **off**: Reject messages with trailing non-whitespace content after the JSON object. Such messages will be treated as non-JSON.

Whitespace characters (spaces, tabs, newlines) are always allowed after the JSON object regardless of this setting.

This parameter is only effective when mode="find-json".

Input usage
-----------
.. _mmjsonparse.parameter.allow_trailing-usage:

.. code-block:: rsyslog

   # Allow trailing data (default)
   action(type="mmjsonparse" mode="find-json" allow_trailing="on")
   
   # Reject messages with trailing data
   action(type="mmjsonparse" mode="find-json" allow_trailing="off")

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