blob: 20a44f7ae1c8fb8466c1f2f9e6c64b7540240056 (
plain)
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
54
55
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head>
<title>CEE/lumberjack JSON support Module (mmjsonparse)</title>
</head>
<body>
<a href="rsyslog_conf_modules.html">back</a>
<h1>Log Message Normalization Module</h1>
<p><b>Module Name: mmjsonparse</b></p>
<p><b>Available since: </b>6.6.0+
<p><b>Author: </b>Rainer Gerhards <rgerhards@adiscon.com></p>
<p><b>Description</b>:</p>
<p>This module provides support for parsing structured log messages
that follow the CEE/lumberjack spec. The so-called "CEE cookie" is checked
and, if present, the JSON-encoded structured message content is parsed.
The properties are than available as original message properties.
</p>
<p>The "CEE cookie" is the character squence "@cee:" which must prepend the
actual JSON. Note that the JSON must be valid and MUST NOT be followed by
any non-JSON message. If either of these conditions is not true, mmjsonparse
will <b>not</b> parse the associated JSON. This is based on the cookie
definition used in CEE/project lumberjack and is meant to aid against
an errornous detection of a message as being CEE where it is not.
<p>This also means that mmjsonparse currently is NOT a generic JSON
parser that picks up JSON from whereever it may occur in the message. This
is intentional, but future versions may support config parameters to
relax the format requirements.
<p><b>Action specific Configuration Directives</b>:</p>
<p>currently none
<ul>
<p><b>Legacy Configuration Directives</b>:</p>
<p>none
<b>Caveats/Known Bugs:</b>
<p>None known at this time.
</ul>
<p><b>Sample:</b></p>
<p>This activates the module and applies normalization to all messages:<br>
</p>
<textarea rows="2" cols="60">module(load="mmjsonparse")
action(type="mmjsonparse")
</textarea>
<p>The same in legacy format:</p>
<textarea rows="2" cols="60">$ModLoad mmjsonparse
*.* :mmjsonparse:
</textarea>
<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
<p><font size="2">This documentation is part of the
<a href="http://www.rsyslog.com/">rsyslog</a>
project.<br>
Copyright © 2012 by <a href="http://www.gerhards.net/rainer">Rainer
Gerhards</a> and
<a href="http://www.adiscon.com/">Adiscon</a>.
Released under the GNU GPL version 3 or higher.</font></p>
</body></html>
|
