1 files changed, 68 insertions, 4 deletions
diff --git a/doc/property_replacer.html b/doc/property_replacer.html
index 5dbdc4c6..4c92bf4c 100644
--- a/doc/property_replacer.html
+++ b/doc/property_replacer.html
@@ -13,7 +13,7 @@ the value, e.g. by converting all characters to lower case.</p>
 <p>Syslog message properties are used inside templates. They are
 accessed by putting them between percent signs. Properties can be
 modified by the property replacer. The full syntax is as follows:</p>
-<blockquote><b><code>%propname:fromChar:toChar:options%</code></b></blockquote>
+<blockquote><b><code>%propname:fromChar:toChar:options:fieldname%</code></b></blockquote>
 <h2>Available Properties</h2>
 <p><b><code>propname</code></b> is the
 name of the property to access. It is case-insensitive (prior to 3.17.0, they were case-senstive).
@@ -65,8 +65,7 @@ BSD syslogd. For example, when TAG is "named[12345]", programname is
 </tr>
 <tr>
 <td><b>pri-text</b></td>
-<td>the PRI part of the message in a textual form with the numerical PRI appended in 
-brackes (e.g.  "local0.err<133>")</td>
+<td>the PRI part of the message in textual form (e.g.  "syslog.info")</td>
 </tr>
 <tr>
 <td><b>iut</b></td>
@@ -139,6 +138,25 @@ draft-ietf-syslog-protocol</td>
 <td>The contents of the MSGID field from
 IETF draft draft-ietf-syslog-protocol</td>
 </tr>
+<tr>
+<td><b>parsesuccess</b></td>
+<td>This returns the status of the <b>last</b> called higher level parser,
+like mmjsonparse. A higher level parser parses the actual message for additional
+structured data and maintains an extra property table while doing so (this is
+often referred to as "cee data" because the idea was originally rooted in the
+cee effort, only (but has been extended since then). Note that higher level
+parsers must explicitely support (and set) this property. So, depending on the
+parser, it may not be set correctly.
+<br>If the parser properly supports it, the value "OK" means that parsing was
+successfull, while "FAIL" means the parser could not successfully obtain any data.
+Failure state is not necessarily an error. For example, it may simple indicate
+that the cee-enhanced syslog parser (mmjsonparse) did not detect cee-enhanced format,
+what can be totally valid. Using this property, further processing of the message
+can be directed based on this parsing outcome. If no parser has been called at the
+time this property is accessed, it will contain "FAIL".
+<br><b>This property is available since version 6.3.8.</b>
+</td>
+</tr>
 <td><b>inputname</b></td>
 <td>The name of the input module that generated the
 message (e.g. "imuxsock", "imudp"). Note that not all modules
@@ -161,6 +179,10 @@ than messages generated somewhere.
 in templates for RFC5424 support, when the character set is know to be
 Unicode.</td>
 </tr>
+<td><b>$uptime</b></td>
+<td>system-uptime in seconds (as reported by operating system).
+</td>
+</tr>
 <tr>
 <td><b>$now</b></td>
 <td>The current date stamp in the format YYYY-MM-DD</td>
@@ -201,6 +223,14 @@ range from 0 to 3 (for the four quater hours that are in each hour)</td>
 <td>The name of the current host as it knows itself (probably useful
 for filtering in a generic way)</td>
 </tr>
+<tr>
+<td><b>$!&lt;name&gt;</b></td>
+<td>This is the "bridge" to syslog message normalization (via
+<a href="mmnormalize.html">mmnormalize</a>): name is a name defined
+inside the normalization rule. It has the value selected by the rule
+or none if no rule with this field did match.
+</td>
+</tr>
 </tbody>
 </table>
 <p>Properties starting with a $-sign are so-called system
@@ -325,6 +355,29 @@ case-insensitive. Currently, the following options are defined:
 <td>convert property text to uppercase only</td>
 </tr>
 <tr>
+<td><b>json</b></td>
+<td>encode the value so that it can be used inside a JSON field. This means
+that several characters (according to the JSON spec) are being escaped, for 
+example US-ASCII LF is replaced by "\n".
+The json option cannot be used together with either jsonf or csv options.
+</td>
+</tr>
+<tr>
+<td><b>jsonf</b></td>
+<td><i>(available in 6.3.9+)</i>
+This signifies that the property should be expressed as a json <b>f</b>ield.
+That means not only the property is written, but rather a complete json field in
+the format<br>
+"fieldname"="value"</b>
+where "filedname" is the assigend field name (or the property name if none was assigned)
+and value is the end result of property replacer operation. Note that value supports
+all property replacer options, like substrings, case converson and the like.
+Values are properly json-escaped. However, field names are (currently) not. It is
+expected that proper field names are configured.
+The jsonf option cannot be used together with either json or csv options.
+</td>
+</tr>
+<tr>
 <td valign="top"><b>csv</b></td>
 <td>formats the resulting field (after all modifications) in CSV format
 as specified in <a href="http://www.ietf.org/rfc/rfc4180.txt">RFC 4180</a>.
@@ -333,6 +386,7 @@ text, you need to define a proper template. An example is this one:
 <br>$template csvline,"%syslogtag:::csv%,%msg:::csv%"
 <br>Most importantly, you need to provide the commas between the fields
 inside the template.
+The csv option cannot be used together with either json or jsonf options.
 <br><i>This feature was introduced in rsyslog 4.1.6.</i>
 </td>
 </tr>
@@ -367,6 +421,10 @@ option when forwarding to remote hosts - they may treat the date as invalid
 <td>format as RFC 3339 date</td>
 </tr>
 <tr>
+<td><b>date-unixtimestamp</b></td>
+<td>format as unix timestamp (seconds since epoch)</td>
+</tr>
+<tr>
 <td><b>date-subseconds</b></td>
 <td>just the subseconds of a timestamp (always 0 for a low precision timestamp)</td>
 </tr>
@@ -434,13 +492,19 @@ Useful for secure pathname generation (with dynafiles).
 them. For example "escape-cc,sp-if-no-1st-sp". If you use conflicting options together,
 the last one will override the previous one. For example, using "escape-cc,drop-cc" will
 use drop-cc and "drop-cc,escape-cc" will use escape-cc mode.
+<h2>Fieldname</h2>
+<p><i>(available in 6.3.9+)</i>
+<p>This field permits to specify a field name for structured-data emitting property replacer
+options. It was initially introduced to support the "jsonf" option, for which it provides
+the capability to set an alternative field name. If it is not specified, it defaults to 
+the property name.
 <h2>Further Links</h2>
 <ul>
 <li>Article on "<a href="rsyslog_recording_pri.html">Recording
 the Priority of Syslog Messages</a>" (describes use of templates
 to record severity and facility of a message)</li>
 <li><a href="rsyslog_conf.html">Configuration file
-syntax</a>, this is where you actually use the property replacer.</li>
+format</a>, this is where you actually use the property replacer.</li>
 </ul>
 <p>[<a href="manual.html">manual index</a>]
 [<a href="rsyslog_conf.html">rsyslog.conf</a>]