Metadata-Version: 1.0
Name: pynagios
Version: 0.1.1
Summary: Python library to write Nagios plugins.
Home-page: https://kiip.github.com/pynagios/
Author: Mitchell Hashimoto
Author-email: mitchell@kiip.me
License: MIT License
Description: PyNagios
        ========
        
        PyNagios is a simple Python library meant to make writing
        `Nagios <http://www.nagios.org/>`_ plugins much easier. Nagios
        plugins have `quite a few guidelines <http://nagiosplug.sourceforge.net/developer-guidelines.html>`_
        to adhere to, and PyNagios provides helpers to make this
        easy.
        
        Install
        -------
        
        To install, simply use ``pip`` or ``easy_install``::
        
            pip install pynagios
        
        Documentation
        -------------
        
        Documentation for the latest version can always be found at
        `http://kiip.github.com/pynagios/latest <http://kiip.github.com/pynagios/latest>`_.
        
        Features
        --------
        
        The core features supported by PyNagios:
        
        - Parsing command line arguments such that the standard expected
          arguments (such as ``-H``, ``-w``, ``-c``) are accepted.
        - Returning proper POSIX exit code based on status.
        - Parsing Nagios range formats (such as "@10:20", "~:50", "10", etc.)
        - Outputting status and message.
        - Outputting performance data.
        
        Example
        -------
        
        What all these features result in is a concise, simple, and
        guidelines-compliant Python-based Nagios plugin::
        
            from pynagios import Plugin
        
            class UserCheck(Plugin):
                """
                Nagios plugin to check how many users are logged into this
                machine.
                """
        
                def check(self):
                    # Get the number of logged in users, for now we hardcode
                    users = 27
        
                    # Build a response and exit. This `response_for_value` automatically
                    # creates a response with the proper status given the value and the
                    # warning/critical ranges passed in via the command line.
                    response = self.response_for_value(users, "%d users" % users)
                    response.set_perf_data("users", users)
                    response.set_perf_data("another metric", 27, "MB")
                    return response
        
            if __name__ == 'main':
                # Build the plugin instance and run it. This will also parse
                # command line arguments by default.
                UserCheck().check().exit()
        
        While the above example subclasses ``Plugin``, you're of course welcome
        to simply call `Plugin`s methods directly and build a ``Response``
        yourself.
        
Keywords: nagios,pynagios,monitoring
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Systems Administration
