Metadata-Version: 1.1
Name: mongoop
Version: 0.0.5
Summary: Monitor and locate long running operations on MongoDB and automatically trigger specific actions for alerting and performance analysis.
Home-page: https://github.com/lujeni/mongoop
Author: Lujeni
Author-email: julien@thebault.co
License: BSD
Download-URL: https://github.com/lujeni/mongoop/tags
Description: What is Mongoop ?
        =================
        Monitor and locate long running operations on MongoDB and automatically trigger specific actions for alerting and performance analysis.
        
        Is it ready ?
        =============
        It's still not 1.0 but enought mature to test on your infrastructure.
        
        Documentation
        =============
        Up to date documentation:
        
        - `See the wiki <https://github.com/lujeni/mongoop/wiki>`_
        
        Learn how to write your own triggers:
        
        - `Write your own triggers <https://github.com/lujeni/mongoop/wiki/Write-your-own-triggers>`_
        
        Usage
        =====
        Currently, mongoop is a simple cli tool:
        ::
        
            mongoop
        
        
        Using your own settings as well:
        ::
        
            mongoop --config /path/to/settings.py
        
        Settings
        ========
        Settings are a python file, you can override them easily.
        ::
        
            # default
            mongodb_host = 'localhost'
        
            mongodb_port = 27017
        
            mongodb_credentials = None
        
            mongodb_options = None
        
            frequency = 10
        
            # the default threshold timeout is set to 60s
            # when no triggers directive is provided.
            triggers = {}
        
            # sample of  triggers
            triggers = {
                'mongodb': {
                    'threshold': 5,
                    'database': 'mongoop',
                    'collection': 'history',
                },
                'nsca': {
                    'threshold': 5,
                    'monitoring_server': 'nagios.foo.com',
                    'service': 'mongoop',
                },
                'nsca': {
                    'threshold': 60,
                    'monitoring_server': 'nagios.foo.com',
                    'service': 'mongoop',
                    'status': 'critical',
                },
                'email': {
                    'threshold': 60,
                    'subject': 'Mongoop report',
                    'from': 'mongoop@localhost',
                    'to': 'root',
                    'smtp_host': 'localhost',
                },
                'killer': {
                    'threshold': 120
                }
            }
        
        
        Requirements
        ============
        This code has been run on Python 2.7
        ::
        
          # install by the setup
          gevent==1.0.2
          pymongo==3.0.2
          pynsca==1.5  pymongo==3.0.2
        
        
        Installation
        ============
        Pypi
        ----
        Using pip:
        ::
        
            $ pip install mongoop
        
        Gentoo Linux
        ------------
        Using emerge (very soon):
        ::
        
            $ sudo emerge -a mongoop
        
        
        Triggers
        ========
        
        Killer
        ------
        Terminates an operation as specified by the operation ID.
        
        MongoDB
        --------
        Insert the slow OP in a different database and do what you want.
        
        Currently, mongoop use the combo (database/collection).
        
        An index is created on the opid field.
        
        Email
        -----
        Send an email with each opid.
        
        
Platform: any
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
