diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2011-12-16 10:31:17 +0100 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2011-12-16 10:31:17 +0100 |
| commit | 21c2f630e9ce218f86b1bd314e7c803b381fcec2 (patch) | |
| tree | 54ca01aac247772382e46d24cc1b0f7813643272 | |
| parent | cb0087ec4736089d73d0368e683b652013483a52 (diff) | |
| download | rsyslog-21c2f630e9ce218f86b1bd314e7c803b381fcec2.tar.gz rsyslog-21c2f630e9ce218f86b1bd314e7c803b381fcec2.tar.xz rsyslog-21c2f630e9ce218f86b1bd314e7c803b381fcec2.zip | |
added doc for omprog
| -rw-r--r-- | ChangeLog | 1 | ||||
| -rw-r--r-- | doc/omprog.html | 43 | ||||
| -rw-r--r-- | doc/rsyslog_conf_modules.html | 1 |
3 files changed, 45 insertions, 0 deletions
@@ -8,6 +8,7 @@ Version 4.8.1 [v4-stable], 2011-09-?? - bugfix: potential abort after reading invalid X.509 certificate closes: http://bugzilla.adiscon.com/show_bug.cgi?id=290 Thanks to Tomas Heinrich for the patch +- added doc for omprog --------------------------------------------------------------------------- Version 4.8.0 [v4-stable] (rgerhards), 2011-09-07 *************************************************************************** diff --git a/doc/omprog.html b/doc/omprog.html new file mode 100644 index 00000000..471ab224 --- /dev/null +++ b/doc/omprog.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><title>omprog output module - sending messages to a program</title> +<a href="features.html">back</a> +</head> +<body> +<h1>Program integration Output module</h1> +<p><b>Module Name: omprog</b></p> +<p><b>Available since: </b> 4.3.0</p> +<p><b>Author: </b>Rainer Gerhards +<rgerhards@adiscon.com></p> +<p><b>Description</b>:</p> +<p>This module permits to integrate arbitrary external programs into rsyslog's +logging. It is similar to the "execute program (^)" action, but offers better security +and much higher performance. While "execute program (^)" can be a useful tool for +executing programs if rare events occur, omprog can be used to provide massive +amounts of log data to a program. +<p>Executes the configured program and feeds log messages to that binary via +stdin. The binary is free to do whatever it wants with the supplied data. +If the program terminates, it is re-started. If rsyslog terminates, the +program's stdin will see EOF. The program must than terminate. The message format +passed to the program can, as usual, be modified by defining rsyslog templates. +<p>Note that each time an omprog action is defined, the corresponding programm +is invoked. A single instance is <b>not</b> being re-used. There are arguments pro and +con re-using existing binaries. For the time being, it simply is not done. In the future, +we may add an option for such pooling, provided that some demand for that is voiced. +You can also mimic the same effect by defining multiple rulesets and including them (at +the price of some slight performance loss). +<p><b>Configuration Directives</b>:</p> +<ul> +<li><b>$ActionOMProgBinary</b> <binary><br> +The binary program to be executed. +</ul> +<b>Caveats/Known Bugs:</b> +<p>Currently none known. +<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 © 2008-2011 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 b2830535..d9a59d8c 100644 --- a/doc/rsyslog_conf_modules.html +++ b/doc/rsyslog_conf_modules.html @@ -52,6 +52,7 @@ generic database output module (Firebird/Interbase, MS SQL, Sybase, SQLLite, Ingres, Oracle, mSQL)</li> <li><a href="ommail.html">ommail</a> - permits rsyslog to alert folks by mail if something important happens</li> +<li><a href="omprog.html">omprog</a> - permits sending messages to a program for custom processing</li> <li><a href="omoracle.html">omoracle</a> - output module for Oracle (native OCI interface)</li> <li><a href="omuxsock.html">omuxsock</a> - output module Unix domain sockets</li> </ul> |