summaryrefslogtreecommitdiffstats
path: root/plugins/ommongodb/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/ommongodb/README')
-rw-r--r--plugins/ommongodb/README40
1 files changed, 40 insertions, 0 deletions
diff --git a/plugins/ommongodb/README b/plugins/ommongodb/README
new file mode 100644
index 00000000..71d56cfa
--- /dev/null
+++ b/plugins/ommongodb/README
@@ -0,0 +1,40 @@
+plugin to use MongoDB as backend.
+
+tested in ubuntu 10.04 and ubuntu 10.10
+
+BUILDING THIS PLUGIN
+Right now, it seems to be necessary to copy the 10gen c-driver directly under
+the ./plugins/ommongodb subdirectory. Then, you need to follow their build
+instructions on how to build the mongodb c driver:
+http://api.mongodb.org/c/current/building.html
+
+This is clumpsy, and if someone has ideas on how to improve this situation,
+please drop us a line. For obvious reasons, ./configure does not detect
+a missing mongodb c driver.
+
+In order to successfully build ommongodb, you NEED to use the v0.2 version of
+the mongo c driver. As it looks, the driver breaks API compatibility and the
+curret v0.4 driver seems to have a totally different API (at least this is
+what I currently (2012-03-08) see.
+
+configuration:
+
+in your /etc/rsyslog.conf, together with other modules:
+$ModLoad ommongodb # provides mongodb support
+
+then in your /etc/rsyslog.d (check your distribution way to organize the configuration..) you create a file 10-mongodb.conf with the following content:
+
+*.* action(type="ommongodb" db="..." collection="...")
+
+Note: currently templates are not supported. Ommongodb will pick a default
+schema and use the message object content for that (templateless).
+
+
+TODO
+we must ensure that the collection is a capped collection
+refactor my code :-)
+
+email Victor Pereira <victor.pereira@bigrails.com>
+twitter twitter.com/vpereira
+
+part of this doc by Rainer Gerhards <rgerhards@adiscon.com>