Imported Upstream version 7.6.1upstream/7.6.1

1 files changed, 10 insertions, 0 deletions

diff --git a/doc/mmjsonparse.html b/doc/mmjsonparse.html
index c2c862d..20a44f7 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>