summaryrefslogtreecommitdiff
path: root/plugins/ommongodb/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/ommongodb/README')
-rw-r--r--plugins/ommongodb/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/ommongodb/README b/plugins/ommongodb/README
index ad4a8ea..1d9567a 100644
--- a/plugins/ommongodb/README
+++ b/plugins/ommongodb/README
@@ -16,3 +16,13 @@ changed in v7.
If templates are used, it is suggested to use list-based templates. Constants
can ONLY be inserted with list-based templates, as only these provide the
capability to specify a field name (outname parameter).
+
+A very basic example is:
+
+*.* action(type="ommongodb" db="logs" collection="syslog")
+
+Please see the script clean-mongo-syslog for an example of how to
+purge old records from MongoDB using PyMongo. It can be run
+daily or weekly from cron.
+
+