2
0
mirror of https://github.com/munin-monitoring/contrib.git synced 2018-11-08 00:59:34 +01:00

Updated the README

This commit is contained in:
Michel Albert 2012-04-06 16:31:48 +02:00
parent ba0efcacfb
commit 0da7b997ba

View File

@ -11,6 +11,14 @@ Requirements
PyPMMN does not have any requirements other than the python standard library. PyPMMN does not have any requirements other than the python standard library.
For compatibility, it's targeted for Python 2.4 and up. 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 Installation
============ ============
@ -27,8 +35,26 @@ this is ``/usr/local/bin``.
Manually Manually
-------- --------
Download the folder and copy the file ``pypmmn/pypmmn.py`` to a location of Download the folder and copy both files ``pypmmn/pypmmn.py`` and
your choice and ensure it's executable. ``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 .. _pmmn: http://blog.pwkf.org/post/2008/11/04/A-Poor-Man-s-Munin-Node-to-Monitor-Hostile-UNIX-Servers