File: mmjsonparse-mode.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 (49 lines) | stat: -rw-r--r-- 1,326 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-mmjsonparse-mode:
.. _mmjsonparse.parameter.mode:

mode
====

.. index::
   single: mmjsonparse; mode
   single: mode
   single: parsing mode

.. summary-start

Specifies the parsing mode for JSON content detection.

.. summary-end

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

:Name: mode
:Scope: action
:Type: string
:Default: cookie
:Required?: no
:Introduced: 8.2506.0

Description
-----------
Sets the parsing mode to determine how JSON content is detected and processed.

- **cookie** (default): Legacy CEE cookie mode. Expects messages to begin with the configured cookie (default "@cee:") followed by JSON content. This preserves backward compatibility with existing configurations.
- **find-json**: Scans the message to locate the first valid top-level JSON object "{...}" regardless of its position. The module uses a tokenizer-aware scanner that respects quotes and escapes to find complete JSON objects.

Input usage
-----------
.. _mmjsonparse.parameter.mode-usage:

.. code-block:: rsyslog

   # Legacy CEE cookie mode (default)
   action(type="mmjsonparse" mode="cookie")
   
   # Find-JSON scanning mode
   action(type="mmjsonparse" mode="find-json")

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