From 9b386f259e2b0e5389be7851e698908eac45d75e Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Mon, 15 Oct 2007 06:59:39 +0000 Subject: upgraded user doc to cover new module action calling convention --- doc/rsyslog_conf.html | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index ec99a600..06e0efbe 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -546,9 +546,26 @@ might be too late.

Emergency messages often go to all users currently online to notify them that something strange is happening with the system. To specify this wall(1)-feature use an asterisk ("*'').

+

Call Plugin

+

This is a generic way to call an output plugin. The plugin must support this +functionality. Actual parameters depend on the module, so see the module's doc +on what to supply. The general syntax is as follows:

+

:modname:params;template

+

Currently, the ommysql database output module supports this syntax (in +addtion to the ">" syntax it traditionally supported). For ommysql, the module +name is "ommysql" and the params are the traditional ones. The ;template part is +not module specific, it is generic rsyslog functionality available to all +modules.

+

As an example, the ommysql module may be called as follows:

+

:ommysql:dbhost,dbname,dbuser,dbpassword;dbtemplate

+

For details, please see the "Database Table" section of this documentation.

+

Note: as of this writing, the ":modname:" part is hardcoded into the module. +So the name to use is not necessarily the name the module's plugin file is +called.

Database Table

This allows logging of the message to a database table. Currently, only MySQL -databases are supported. By default, a MonitorWare-compatible schema is required +databases are supported. However, other database drivers will most probably be +developed as plugins. By default, a MonitorWare-compatible schema is required for this to work. You can create that schema with the createDB.SQL file that came with the rsyslog package. You can also
use any other schema of your liking - you just need to define a proper template -- cgit