Contents¶

Installation¶

pip install git+https://github.com/thanos/supervisor-sysinfo.git

Documentation¶

https://supervisor-sysinfo.readthedocs.org/

Requirements¶

• Python 2.7+
• supervisor 3.0+
• psutil

Why¶

I use supervisor on many of my servers for control and monitoring and I needed a way to interrogate the sevrers for top, df and ps type information. Rather than have my own status server I’ve extended supervisor’s XML-RPC api to offer two new functions:

• sysinfo.ps which returns a dictionary keyed by pid of the output of ps aux.
• sysinfo.sysInfo which reruns cpu, memory and disk usage information.

Both functions return json strings. I do this as a work around the 32-bit int limitation of the XML-RPC standard.

Installation¶

Use the usual ways:

pip install git+https://github.com/thanos/supervisor-sysinfo.git

Setup¶

In your supervisor.conf file setup:

[inet_http_server]
port = *:9002
username = very_safe
password = very_safe

Uncomment:

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

Add:

      [rpcinterface:sysinfo]
      supervisor.rpcinterface_factory = supervisor_sysinfo.rpcinterface:make_sysinfo_rpcinterface

[eventlistener:monitor]
command=supervisor_monitor http://some_end_point.com:7000/monitor
events= TICK_60

Usage¶

You can look at the test code but effectively you need to do this:

import xmlrpclib,pprint, json

rpc_proxy =  xmlrpclib.ServerProxy('http://very_safe:very_safe@127.0.0.1:9002')

ps_list = json.loads(rpc_proxy.sysinfo.ps())
pprint.pprint(ps_list)

sysInfo =  json.loads(rpc_proxy.sysinfo.sysInfo())
pprint.pprint(sysInfo)

Development¶

To run the all tests run:

tox

Bug reports¶

When reporting a bug please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Documentation improvements¶

supervisor-sysinfo could always use more documentation, whether as part of the official supervisor-sysinfo docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback¶

The best way to send feedback is to file an issue at https://github.com/thanos/supervisor-sysinfo/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development¶

To set up supervisor-sysinfo for local development:

1. Fork supervisor-sysinfo on GitHub.

2. Clone your fork locally:

   git clone git@github.com:your_name_here/supervisor-sysinfo.git
   

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

4. When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:

   tox
   

5. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "Your detailed description of your changes."
   git push origin name-of-your-bugfix-or-feature
   

6. Submit a pull request through the GitHub website.

tox -e envname -- py.test -k test_myfeature

detox

0.1.0 (2016-01-19)¶

• First release on PyPI.