diff options
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/mmpstrucdata.html | 59 | ||||
| -rw-r--r-- | doc/rsyslog_conf_modules.html | 2 |
3 files changed, 62 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index b37fd642..ce16122f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -37,6 +37,7 @@ html_files = \ omjournal.html \ imjournal.html \ mmanon.html \ + mmpstrucdata.html \ omusrmsg.html \ omstdout.html \ omudpspoof.html \ diff --git a/doc/mmpstrucdata.html b/doc/mmpstrucdata.html new file mode 100644 index 00000000..b4003062 --- /dev/null +++ b/doc/mmpstrucdata.html @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head> +<meta http-equiv="Content-Language" content="en"> +<title>RFC5424 structured data parsing module (mmpstrucdata)</title></head> + +<body> +<a href="rsyslog_conf_modules.html">back</a> + +<h1>RFC5424 structured data parsing module (mmpstrucdata)</h1> +<p><b>Module Name: mmpstrucdata</b></p> +<p><b>Author: </b>Rainer Gerhards <rgerhards@adiscon.com></p> +<p><b>Available since</b>: 7.5.4</p> +<p><b>Description</b>:</p> +<p>The mmpstrucdata parses RFC5424 structured data into the message +json variable tree. +<p> </p> + +<p><b>Module Configuration Parameters</b>:</p> +<p>Currently none. +<p> </p> +<p><b>Action Confguration Parameters</b>:</p> +<ul> +<li><b>jsonRoot</b> - default "!"<br> +Specifies into which json container the data shall be parsed to. +</ul> + +<p><b>See Also</b> +<ul> +<li><a href="http://www.rsyslog.com/howto-anonymize-messages-that-go-to-specific-files/">Howto anonymize messages that go to specific files</a> +</ul> + + +<p><b>Caveats/Known Bugs:</b> +<ul> +<li>this module is currently experimental; feedback is appreciated +<li>structured data with duplicate SD-IDs and SD-PARAMS is not + properly processed +</ul> + +<p><b>Samples:</b></p> +<p>In this snippet, we parse the message and emit all json variable to a file +with the message anonymized. Note that once mmpstrucdata has run, access to the +original message is no longer possible (execept if stored in user +variables before anonymization). +<p><textarea rows="5" cols="60">module(load="mmpstrucdata") +action(type="mmpstrucdata") +template(name="jsondump" type="string" string="%msg%: %$!%\n") +action(type="omfile" file="/path/to/log" template="jsondump") +</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 © 2013 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> diff --git a/doc/rsyslog_conf_modules.html b/doc/rsyslog_conf_modules.html index 4d060af0..6944eb54 100644 --- a/doc/rsyslog_conf_modules.html +++ b/doc/rsyslog_conf_modules.html @@ -118,6 +118,8 @@ specially formatted messages (e.g. CEF) Note that this actually is a <b>generic</b> module. <li><a href="mmjsonparse.html">mmjsonparse</a> - used to interpret CEE/lumberjack enabled structured log messages. +<li><a href="mmpstrucdata.html">mmpstrucdata</a> - used to parse RFC5424 structured data +into json message properties <li><a href="mmsnmptrapd.html">mmsnmptrapd</a> - uses information provided by snmptrapd inside the tag to correct the original sender system and priority of messages. Implemented via the output module interface. |