From 28047567a2363f83b24b13108c626423dc1f1821 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Tue, 6 Nov 2012 12:08:09 +0100 Subject: doc: improve ommongodb doc --- doc/ommongodb.html | 60 +++++++++++++++++++++++++++++++++++++++++++ doc/rsyslog_conf_modules.html | 1 + 2 files changed, 61 insertions(+) create mode 100644 doc/ommongodb.html diff --git a/doc/ommongodb.html b/doc/ommongodb.html new file mode 100644 index 00000000..a6112642 --- /dev/null +++ b/doc/ommongodb.html @@ -0,0 +1,60 @@ + + + +MongoDB Output Module + + + +back + +

MongoDB Output Module

Module Name: ommongodb

Author: Rainer Gerhards +<rgerhards@adiscon.com>

Description:

This module provides native support for logging to MongoDB. +

Action Parameters:

server
Name or address of the MongoDB server +
serverport
Permits to select +a non-standard port for the MongoDB server. The default is 0, which means the +system default port is used. There is no need to specify this parameter unless +you know the server is running on a non-standard listen port. +
db
Database to use +
collection
Collection to use +
uid
logon userid used to connect to server. Must have proper permissions. +
pwd
the user's password +
template
Template to use when submitting messages. +

Note rsyslog contains a canned default template to write to the MongoDB. It +will be used automatically if no other template is specified to be used. This template is: +

+template(name="BSON" type="string" string="\"sys\" : \"%hostname%\", \"time\" : \"%timereported:::rfc3339%\", \"time_rcvd\" : \"%timegenerated:::rfc3339%\", \"msg\" : \"%msg%\", \"syslog_fac\" : \"%syslogfacility%\", \"syslog_sever\" : \"%syslogseverity%\", \"syslog_tag\" : \"%syslogtag%\", \"procid\" : \"%programname%\", \"pid\" : \"%procid%\", \"level\" : \"%syslogpriority-text%\"") + +

This creates the BSON document needed for MongoDB if no template is specified. The default +schema is aligned to CEE and project lumberjack. As such, the field names are standard +lumberjack field names, and not +rsyslog property names. When specifying templates, be sure +to use rsyslog property names as given in the table. If you would like to use lumberjack-based +field names inside MongoDB (which probably is useful depending on the use case), you need to +select fields names based on the lumberjack schema. +If you just want to use a subset of the fields, but with lumberjack names, you can look up the +mapping in the default template. For example, the lumberjack field "level" contains the rsyslog +property "syslogpriority-text". +

Sample:

The following sample writes all syslog messages to the +database "syslog" and into the collection "log" on mongosever.example.com. The server is +being accessed under the account of "user" with password "pwd". +

+ +

[rsyslog.conf overview] +[manual index] [rsyslog site]

This documentation is part of the +rsyslog project.
+Copyright © 2008-2012 by Rainer Gerhards and +Adiscon. +Released under the ASL 2.0.

+ diff --git a/doc/rsyslog_conf_modules.html b/doc/rsyslog_conf_modules.html index 73d6c689..d18e5123 100644 --- a/doc/rsyslog_conf_modules.html +++ b/doc/rsyslog_conf_modules.html @@ -72,6 +72,7 @@ permits rsyslog to alert folks by mail if something important happens

omudpspoof - output module sending UDP syslog messages with a spoofed address

omuxsock - output module Unix domain sockets

omhdfs - output module for Hadoop's HDFS file system

ommongodb - output module for MongoDB

Parser Modules

-- cgit v1.2.3