From 0da7b997bafd908514369dda5508d09e47e04965 Mon Sep 17 00:00:00 2001 From: Michel Albert Date: Fri, 6 Apr 2012 16:31:48 +0200 Subject: [PATCH] Updated the README --- tools/pypmmn/README.rst | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/tools/pypmmn/README.rst b/tools/pypmmn/README.rst index 0af491d8..48687a8f 100644 --- a/tools/pypmmn/README.rst +++ b/tools/pypmmn/README.rst @@ -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