Robot/contrib-munin
2
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2018-11-08 00:59:34 +01:00
Code Issues Releases Wiki Activity

Updated the README

Browse Source
This commit is contained in:
Michel Albert 2012-04-06 16:31:48 +02:00
parent ba0efcacfb
commit 0da7b997ba
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
tools/pypmmn/README.rst
View File

@ -11,6 +11,14 @@ Requirements
PyPMMN does not have any requirements other than the python standard library.
For compatibility, it's targeted for Python 2.4 and up.
Known Issues
============
* The stdin mode does not work correctly. Consider using the original pmmn_
instead.
* It's not multithreaded. Only one connection is handled at a time. But given
the nature of munin, this should not be an issue.
Installation
============
@ -27,8 +35,26 @@ this is ``/usr/local/bin``.
Manually
--------
Download the folder and copy the file ``pypmmn/pypmmn.py`` to a location of
your choice and ensure it's executable.
Download the folder and copy both files ``pypmmn/pypmmn.py`` and
``pypmmn/daemon.py`` to a location of your choice and ensure ``pypmmn.py`` is
executable.
Usage
=====
All command-line parameters are documented. Simply run::
pypmmn.py --help
to get more information.
Daemon mode
-----------
In daemon mode, it's very helpful to specify a log folder. It gives you a
means to inspect what's happening. In the case you specified a log folder,
pypmmn will also create a file called ``pypmmn.pid`` containing the PID of the
daemon for convenience.
.. _pmmn: http://blog.pwkf.org/post/2008/11/04/A-Poor-Man-s-Munin-Node-to-Monitor-Hostile-UNIX-Servers