summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2013-06-17 08:00:50 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2013-06-17 08:00:50 +0200
commit2832c52fb409cb437c8cc1006183a5a7e2d668ef (patch)
tree7ec78c9ffcf403fd8eeea3f125a57b47428df348
parent03dedf4568f0f2d9c645b1dc905325087984d9ca (diff)
downloadrsyslog-2832c52fb409cb437c8cc1006183a5a7e2d668ef.tar.gz
rsyslog-2832c52fb409cb437c8cc1006183a5a7e2d668ef.tar.bz2
rsyslog-2832c52fb409cb437c8cc1006183a5a7e2d668ef.zip
doc: improve imjournal doc
most importantly, convert sample to new-style config format
-rw-r--r--doc/imjournal.html36
1 files changed, 19 insertions, 17 deletions
diff --git a/doc/imjournal.html b/doc/imjournal.html
index 4095dba2..1e82f7f1 100644
--- a/doc/imjournal.html
+++ b/doc/imjournal.html
@@ -65,18 +65,6 @@ ratelimit.interval interval. For futher information, see description there.
</ul>
-<p><b>Legacy Configuration Directives</b>:</p>
-<ul>
-<li>$imjournalPersistStateInterval &lt;Delimiter&gt;<br>
-Equivalent to: ratelimit.PersistStateInterval</li>
-<li>$imjournalStateFile &lt;Delimiter&gt;<br>
-Equivalent to: ratelimit.StateFile</li>
-<li>$imjournalRatelimitInterval &lt;Delimiter&gt;<br>
-Equivalent to: ratelimit.interval</li>
-<li>$imjournalRatelimitBurst &lt;Delimiter&gt;<br>
-Equivalent to: ratelimit.burst</li>
-</ul>
-
<b>Caveats/Known Bugs:</b>
<p>
<ul>
@@ -87,17 +75,31 @@ control of the rsyslog team.
</p>
<p><b>Sample:</b></p>
<p>
-The following example shows pulling structured imjournal messages and saving them into /var/log/ceelog
+The following example shows pulling structured imjournal messages and saving them into /var/log/ceelog.
</p>
-<textarea rows="11" cols="60">
+<textarea rows="11" cols="80">
module(load="imjournal" PersistStateInterval="100" StateFile="/path/to/file") #load imjournal module
module(load="mmjsonparse") #load mmjsonparse module for structured logs
-$template CEETemplate,"%TIMESTAMP% %HOSTNAME% %syslogtag% @cee: %$!all-json%\n" #template for messages
+template(name="CEETemplate" type="string"
+ string="%TIMESTAMP% %HOSTNAME% %syslogtag% @cee: %$!all-json%\n"
+ ) #template for messages
-*.* :mmjsonparse:
-*.* /var/log/ceelog;CEETemplate
+action(type="mmjsonparse")
+action(type="omfile" file="/var/log/ceelog" template="CEETemplate")
</textarea>
+<p><b>Legacy Configuration Directives</b>:</p>
+<ul>
+<li>$imjournalPersistStateInterval &lt;Delimiter&gt;<br>
+Equivalent to: ratelimit.PersistStateInterval</li>
+<li>$imjournalStateFile &lt;Delimiter&gt;<br>
+Equivalent to: ratelimit.StateFile</li>
+<li>$imjournalRatelimitInterval &lt;Delimiter&gt;<br>
+Equivalent to: ratelimit.interval</li>
+<li>$imjournalRatelimitBurst &lt;Delimiter&gt;<br>
+Equivalent to: ratelimit.burst</li>
+</ul>
+
</body>
</html>