diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2013-09-16 18:54:18 +0200 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2013-09-16 18:54:18 +0200 |
| commit | 629efc063125d9f63d4fe30e4f9e86dc44429ad1 (patch) | |
| tree | df5b58f77cdf7193228afdfb23efc7bb35d43b6e /doc/mmjsonparse.html | |
| parent | 42c0f21ced49f23644aa52a18e1995f867e4fd18 (diff) | |
| download | rsyslog-629efc063125d9f63d4fe30e4f9e86dc44429ad1.tar.gz rsyslog-629efc063125d9f63d4fe30e4f9e86dc44429ad1.tar.bz2 rsyslog-629efc063125d9f63d4fe30e4f9e86dc44429ad1.zip | |
doc: describe "CEE cookie" required by mmjsonparse
... as well as other format requirements.
Diffstat (limited to 'doc/mmjsonparse.html')
| -rw-r--r-- | doc/mmjsonparse.html | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/mmjsonparse.html b/doc/mmjsonparse.html index c2c862d7..20a44f7a 100644 --- a/doc/mmjsonparse.html +++ b/doc/mmjsonparse.html @@ -15,6 +15,16 @@ 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> |