Skip to content

Latest commit

 

History

History
159 lines (108 loc) · 5.76 KB

README.md

File metadata and controls

159 lines (108 loc) · 5.76 KB

pymonster

PyMonster is a flexible python event logging and consuming library. It is an implementation of the description of an event system used at Stripe called Monster outlined in this talk: Theres a Monster in my Closet

##Requirements

##Example

###Setup (shell commands) These commands make a directory called pymonster-test, setup a virtual python environment via virtualenv, and install the necessary dependancies, and open a python terminal.

mkdir pymonster-test
cd pymonster-test
virtualenv venv --distribute
source venv/bin/activate
pip install pymongo mongomock
pip install -e git://github.com/texuf/pymonster/#egg=pymonster
python

###Logging Events Now we're going to instantiate our event manager, point it to some of our example classes and start logging events

import os
import pymonster
import pymongo as mongo
#import mongomock as mongo #use this if you want to use mongomock instead of a running mongo instance

#set verbosity for the demo
pymonster.verbose = True

#initialize your db
db_uri = os.environ.get('MONGO_URI', 'mongodb://localhost')
db_name = os.environ.get('MONGO_DB', 'pymonster-test')
pymonster.db = mongo.MongoClient(db_uri)[db_name]

#create some events
events = pymonster.EventManager(
        pkg_name='pymonster.example.events'
    )
events.event_1.log('a really cool message')
events.user.bought_shirt.log({'user':'gordon','quantity':2})

You should see this output:

[Event][events_event_1] a really cool message
[Event][events_user_bought_shirt] {'user': 'gordon', 'quantity': 2}

And, if you take a peek in the mongo shell you will see these events in separate collections in your database. Take note, we don't have to create any classes to be able to use these events, but we can!

###Custom Events

When we created our events object, we used the pkg_name="pymonster.example.events" in this folder is a file called custom_1.py which contains an Event class with a custom log message.

#source from: /pymonster/example/events/custom_1.py
from pymonster import EventBase

class Event(EventBase):
    def log(self, msg):
        print '[CustomEventLogger][%s] %s' % (self.collection_name,msg)
        EventBase.log(self, msg)

If we call it:

events.custom_1.log('logging a really great message')

You will see this output:

[CustomEventLogger][events_custom_1] logging a really great message
[Event][events_custom_1] logging a really great message

Using custom events you can add parameters to the log call, assert that the parameters are of the correct type, and manipulate data before logging

###Consumers

In another terminal (or several terminals) run the following,

$ cd pymonster-test
$ source venv/bin/activate
$ python

import os
import pymonster
import pymongo as mongo
#import mongomock as mongo #use this if you want to use mongomock instead of a running mongo instance


#set verbosity for the demo
pymonster.verbose = True

#initialize your db
db_uri = os.environ.get('MONGO_URI', 'mongodb://localhost')
db_name = os.environ.get('MONGO_DB', 'pymonster-test')
pymonster.db = mongo.MongoClient(db_uri)[db_name]

events = pymonster.EventManager(
        pkg_name='pymonster.example.events'
    )

consumers = pymonster.ConsumerManager(
      pkg_name='pymonster.example.consumers'
    )

pymonster.register_events(
        [
            [events.event_1,                        consumers.event_1]
            , [events.user.bought_shirt,        consumers.user.bought_a_shirt]
            , [events.custom_1,                   consumers.custom_1]
        ]
    )
pymonster.consume_events_loop()

Just like events, theres a file in examples/consumers called custom_1.py shown below. By default, the consumer manager will create a BaseConsumer instance that will print out your message.

#source from: /pymonster/example/consumers/custom_1.py
from pymonster import ConsumerBase

class Consumer(ConsumerBase):
    def consume(self, event_instance, event_data):
        print '[CustomConsumer][%s][%s #%d]: %s' % (self.collection_name, event_instance.collection_name, event_data['_id'], str(event_data['msg']))

In the original terminal, fire off some events and watch them get consumed

for i in range(20):
    events.event_1.log('Logging event_1 %d' % i)
    events.custom_1.log('Logging custom event %d' % i)

###Other things Events and Consumers don't have to have a 1 to 1 mapping, and you can create more consumers later that will run over all of your events

pymonster.register_events(
        [
            [events.event_1,                        consumers.my_metrics_counter]
            , [events.event_1,                        consumers.my_machine_learning_process]
            , [events.event_1,                        consumers.email_admins]
        ]
    )

If you're worried about getting bitten by undeclared events and consumers, just turn that feature off

pymonster.allow_undeclared_events = False

You can process events in a background thread in the same terminal like this

pymonster.consume_events_debug_thread()

Or write your own loop that constantly calls

Email me with any feedback at [email protected] and check out www.mighytspring.com!