!IMPORTANT!: Please note that this project is currently unmaintained. Apologies for the inconvenience.
mongoriver is a library to monitor updates to your Mongo databases in near-realtime. It provides a simple interface for you to take actions when records are inserted, removed, or updated.
How it works
MongoDB has an oplog, a log of all write operations.
updates to this oplog. See the Mongo documentation for its oplog for more.
How to use it
Step 1: Create an outlet
You'll need to write a class subclassing Mongoriver::AbstractOutlet.
You can override any of these methods:
insert(db_name, collection_name, document)
remove(db_name, collection_name, document)
update(db_name, collection_name, selector, update)
create_index(db_name, collection_name, index_key, options)
drop_index(db_name, collection_name, index_name)
create_collection(db_name, collection_name, options)
rename_collection(db_name, old_collection_name, new_collection_name)
You should think of these methods like callbacks -- if you want to do something
every time a document is inserted into the Mongo database, override the
insert method. You don't need to override all the methods -- if you only want
to take action on insert and update, just override
Step 2: Create a stream and start the logger
Once you've written your class, you can start tailing the Mongo oplog! Here's the code you'll need to use:
mongo = Mongo::MongoClient.from_uri(mongo_uri) tailer = Mongoriver::Tailer.new([mongo], :existing) outlet = YourOutlet.new(your_params) # Your subclass of Mongoriver::AbstractOutlet here stream = Mongoriver::Stream.new(tailer, outlet) stream.run_forever(starting_timestamp)
starting_timestamp here is the time you want the tailer to start at. We use
this to resume interrupted tailers so that no information is lost.