Metadata-Version: 1.0
Name: redturtle.munin
Version: 1.0a2
Summary: Munin plugins for Zope/Plone.
Home-page: http://plone.org/products/redturtle.munin
Author: Andrew Mleczko
Author-email: andrew.mleczko@redturtle.it
License: GPL
Description: 
        
        Introduction
        ------------
        
        This package provides munin plugins for monitoring various aspects of a Zope
        instance.
        
        It uses `gocept.munin`_ for plugin registration. Please refer to its
        documentation if you want to write new plugins.
        
        Bits of the code is based on plugins found at `munin exchange`_ (many thanks
        to Gaute Amundsen and Arthur Lutz).
        
        
        Plugins
        -------
        
        Currently there are 4 plugins available:
        
        * "zopethreads" - reports free Zope threads
        * "zopecache" - reports database cache parameters
        * "zodbactivity" - reports ZODB activity
        * "zopememory" - reports Zope memory usage (only works on Linux)
        
        
        How to use it
        -------------
        
        * First include the package in your buildout `instance` slot::
        
        [instance]
        ...
        eggs =
        ...
        redturtle.munin
        zcml =
        ...
        redturtle.munin
        
        * To create the pluging helper script you'll also need to include the
        following, additional section and extend your `parts` definition::
        
        [buildout]
        parts =
        ...
        munin
        
        [munin]
        recipe = zc.recipe.egg
        eggs = redturtle.munin
        arguments = http_address='${instance:http-address}', user='${instance:user}'
        
        The `arguments` option is used to pass configuration values to the generated
        helper script, which is then used as the actual munin plugin (see below).
        Any settings for `ip-address`, `http-address`, `port-base` and `user` given
        in the `instance` section should be repeated here, separated by commas.
        
        .. |---| unicode:: U+2014  .. em dash
        
        Please be aware, that the variable names use underscores instead of dashes
        here |---| the following list shows all supported settings and their
        respective default values:
        
        * ip_address='<ip-address>'    ['localhost']
        * http_address=<http-address>  [8080]
        * port_base=<port-base>        [0]
        * user=<user-credentials>      [n.a.]
        
        Either literal values or references to the `instance` part can be used here,
        i.e. "http_address='${instance:http-address}', user='${instance:user}'".
        Please note that the resulting line will be verbosely copied into the
        generated `bin/munin` script, so the extra quoting is required.
        
        * When monitoring more than one Zope instance, i.e. in a ZEO setup, separate
        helper scripts need to be generated.  In order to do so the `scripts`
        option of `zc.recipe.egg` can be used like so::
        
        [buildout]
        parts =
        ...
        munin1
        munin2
        
        [munin1]
        recipe = zc.recipe.egg
        eggs = redturtle.munin
        scripts = munin=munin1
        arguments = http_address='${instance1:http-address}', user='${instance1:user}'
        
        [munin2]
        recipe = zc.recipe.egg
        eggs = redturtle.munin
        scripts = munin=munin2
        arguments = http_address='${instance2:http-address}', user='${instance2:user}'
        
        The necessary symlinks can then be created with each of the scripts in turn
        (see below).  Please note, that in this case you should explicitly provide
        at least a differing `prefix` argument.
        
        * Now you should be able to call the plugins as follow::
        
        http://localhost:8080/@@redturtle.munin.plugins/zopethreads
        
        Where `zopethreads` is you plugin name.  Please note that for security
        reasons the view requires the `View management screens` permission.
        
        * Next you need to make symlinks from the helper script inside your
        buildout's `bin/` to the munin plugin directory.  The helper script itself
        can assist you with this::
        
        $ bin/munin install /opt/munin/etc/plugins [<prefix>] [<suffix>]
        
        This will install the necessary symlinks in the given directory using
        either the provided prefix and suffix or else the hostname and current
        directory to assemble their names (see below).
        
        Alternatively, you may also install the desired symlinks yourself::
        
        $ cd /opt/munin/etc/plugins
        $ ln -s ~/zope/bin/munin company_zodbactivity_site1
        
        Here `/opt/munin/etc/plugins` is your munin directory, `~/zope/` is the
        root directory of your buildout, `zodb_activity` the name of the plugin
        you want to enable, `company` a placeholder for an arbitrary prefix and
        `site1` the name which will be shown in munin.
        
        * Finally configure the plugin in munin (this step can be skipped if you have
        correctly set up the `arguments` option as described in step 2 above)::
        
        $ cd /opt/munin/etc/plugin-conf.d/
        $ vi redturtle.conf
        ... [company_*_site1]
        ... env.AUTH myuser:myuser
        ... env.URL http://localhost:8080/@@redturtle.munin.plugins/%s
        
        Here `myuser:myuser` are your Zope user credentials and `localhost:8080`
        your site url.  Please check `munin`_ for more information about plugin
        configuration.
        
        
        References
        ----------
        
        * `redturtle.munin`_ at pypi
        * `gocept.munin`_ at pypi
        * `munin`_ project
        * `munin exchange`_
        
        .. _redturtle.munin: http://pypi.python.org/pypi/redturtle.munin/
        .. _gocept.munin: http://pypi.python.org/pypi/gocept.munin/
        .. _munin exchange: http://muninexchange.projects.linpro.no/
        .. _munin: http://munin.projects.linpro.no/
        
        
        Contact
        -------
        
        .. image:: http://www.slowfoodbologna.it/redturtle_logo.png
        
        * | Andrew Mleczko <``andrew.mleczko at redturtle.net``>
        | **RedTurtle Technology**, http://www.redturtle.net/
        
        * | Andreas Zeidler <``az at zitc.de``>
        | **ZITC**, http://zitc.de/
        
        Changelog
        =========
        
        1.0a2 - 2009/07/27
        ------------------
        
        * Fix dimension for memory usage plugin.
        [witsch]
        
        * Add info about monitoring more than one instance, e.g. a ZEO setup.
        [witsch]
        
        * Allow overriding the default prefix/suffix when setting up plugin links.
        [witsch]
        
        
        1.0a1 - 2009/07/17
        ------------------
        
        * Add script option to automatically setup symlinks for all available
        plugins in the munin plugin directory.
        [witsch]
        
        * Add plugin to track zope's memory usage (only available on Linux).
        [witsch]
        
        * Add logging of slow plugin execution as a safety net.
        [witsch]
        
        * Allow setting of necessary configuration values directly in buildout.
        [witsch]
        
        * Refactor and try to simplify things.
        [witsch]
        
        
        0.0.3 - 2009/03/30
        ------------------
        
        * Add documentation.
        [amleczko]
        
        * Refactor plugin registration.
        [amleczko]
        
        
        0.0.2 - 2009/03/26
        ------------------
        
        * Small refactoring.
        [amleczko]
        
        
        0.0.1 - 2009/03/24
        ------------------
        
        * Initial release.
        [amleczko]
        
        
Keywords: plone zope munin monitoring
Platform: Any
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Framework :: Plone
Classifier: Framework :: ZODB
Classifier: Framework :: Zope2
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: Software Development :: Libraries :: Python Modules
