File: mmjsonparse-max_scan_bytes.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 (50 lines) | stat: -rw-r--r-- 1,439 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
.. _param-mmjsonparse-max_scan_bytes:
.. _mmjsonparse.parameter.max_scan_bytes:

max_scan_bytes
==============

.. index::
   single: mmjsonparse; max_scan_bytes
   single: max_scan_bytes
   single: scan limit

.. summary-start

Maximum number of bytes to scan when searching for JSON content in find-json mode.

.. summary-end

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

:Name: max_scan_bytes
:Scope: action
:Type: positive integer
:Default: 65536
:Required?: no
:Introduced: 8.2506.0

Description
-----------
Sets the maximum number of bytes to scan when searching for JSON objects in find-json mode. This prevents performance issues with very large messages by limiting the amount of data that will be examined.

When the scan limit is reached without finding a complete JSON object, the message is treated as non-JSON and processed through the fallback path (creating a simple JSON object with the original message as the "msg" field).

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

Input usage
-----------
.. _mmjsonparse.parameter.max_scan_bytes-usage:

.. code-block:: rsyslog

   # Scan up to 32KB for JSON content
   action(type="mmjsonparse" mode="find-json" max_scan_bytes="32768")
   
   # Use default 64KB scan limit
   action(type="mmjsonparse" mode="find-json")

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