This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!
Project Description

Change history

0.17 (2011-07-28)

  • Added support for process groups [nueces]

0.16 (2011-03-07)

  • Fix supervisorctl to use unix_http_server if used [Domen Kožar, NiteoWeb. Work sponsored by Hexagon IT]

0.15 (2011-03-05)

  • Added support for unix_http_server additionally to inet_http_server [Domen Kožar, NiteoWeb. Work sponsored by Hexagon IT]

0.14 (2010-12-10)

  • Added support for the umask option of supervisord [servilio@mcmaster.ca]
  • Move the credentials needed for authenticating with the supervisord process from the supervisorctl script to the configuration file. Because of bug 180705 of zc.buildout, scripts are made world-readable. [servilio@mcmaster.ca]

0.13 (2010-12-07)

  • ‘nocleanup’ option of Supervisor is now configurable from Buildout Patch from Damien Letournel

0.12 (2010-08-04)

  • Quote the environment variables that are written in the supervisor configuration file for eventlisteners, otherwise supervisor will not pass them on correctly to for example memmon [Fred van Dijk]

0.11 (2010-08-02)

0.10.1 (2010-07-27)

  • Updated documentation about how to use the memmon event listener [lucielejard]

0.10 (2010-06-03)

  • Added an option for the environment variable PATH [lucielejard]
  • Added support for disabling supervisor sections (such as http, rpc and ctl) [Domen Kozar]

0.9 (2009-11-04)

  • Applied Jonathan Ballet’s patch: The generated control script doesn’t automatically connect on the created supervisord when running on a custom port.

0.8 (2009-04-27)

  • Make it possible to set additional options per process in the control script. [nkryptic]

0.7 (2009-01-27)

  • Added ‘plugins’ option so we can install extra eggs (supervisor plugins) [mustapha]
  • Some fixes for eventlistner part [mustapha]
  • Updated tests

0.6 (2008-11-10)

  • One can now specify the user account that will be used as the account which runs the program. [amos]

0.5 (2008-08-23)

  • Adding eventlistners option for use as event notification framework. Targetting use with supervisor’s memmon event listener [aburkhalter]

0.4 (2008-06-12)

  • Use dynamic script names to allow multiple cluster [gawel]
  • Ensure that the log dir is created when used without zope’s recipes [gawel]

0.3 (2008-06-01)

  • Updated docs and tests [mustapha]
  • pep8 cosmetics [mustapha]
  • Make it possible to pass in arguments to the control script. [hannosch]
  • Put all specified options, like server url and username into the generated control script. This allows to run it as is. [hannosch]

0.2 (2008-04-23)

  • Make possible to pass arguments to the command so one can use ctl scripts with supervisor with arguments like ‘fg’ for zope instances or –no-detach or something similar for other programs [mustapha]
  • updated tests [mustapha]

0.1 (2008-04-21)

  • Created recipe with ZopeSkel [Mustapha Benali].

Detailed Documentation

This recipe when used will do the following:

  • install supervisor and all its dependecies.
  • generates the supervisord, supervisorctl, and memmon scripts in the bin directory
  • generates a configuration file to be used by supervisord and supervisorctl scripts

Supported options

The recipe supports the following options:

sections
List of enabled supervisor sections. Defaults to “http ctl rpc”
plugins
Extra eggs you want the recipe to install. ie: superlance
http-socket
“inet” or “unix” socket to use for http administration. Defaults to “inet”.
file
A path to a UNIX domain socket (e.g. /tmp/supervisord.sock) on which supervisor will listen for HTTP/XML-RPC requests.
chmod
Change the UNIX permission mode bits of the UNIX domain socket to this value at startup.
port
The port nummber supervisord listen to. ie: 9001. Can be given as host:port like 127.0.0.1:9001. Defaults to 127.0.0.1:9001
user
The username required for authentication to supervisord
password
The password required for authentication to supervisord
supervisord-conf
Full path to where the recipe puts the supervisord configuration file. Defaults to ${buildout:directory}/parts/${name}/supervisord.conf
childlogdir
The full path of the directory where log files of processes managed by Supervisor while be stored. Defaults to ${buildout:directory}/var/log
logfile
The full path to the supervisord log file. Defaults to ${buildout:directory}/var/log/supervisord.log
pidfile
The pid file of supervisord. Defaults to ${buildout:directory}/var/supervisord.pid
logfile-maxbytes
The maximum number of bytes that may be consumed by the activity log file before it is rotated. Defaults to 50MB
logfile-backups
The number of backups to keep around resulting from activity log file rotation. Defaults to 10
loglevel
The logging level. Can be one of critical, error, warn, info, debug, trace, or blather. Defaults to info
umask
The umask of the supervisord process. Defaults to 022.
nodaemon
If true, supervisord will start in the foreground instead of daemonizing. Defaults to false
nocleanup
Prevent supervisord from clearing any existing AUTO child log files at startup time. Useful for debugging. Defaults to false
serverurl
The URL that should be used to access the supervisord server. Defaults to http://127.0.0.1:9001
programs

A list of programs you want the supervisord to control. One per line. The format of a line is as follow:

priority process_name [(process_opts)] command [[args] [directory] [[redirect_stderr]]
[user]]

The [args] is any number of arguments you want to pass to the command It has to be given between [] (ie.: [-v fg]). See examples below. If not given the redirect_stderr defaults to false. If not given the directory option defaults to the directory containing the the command. The optional process_opts argument sets additional options on the proccess in the supervisord configuration. It has to be given between () and must contain options in key=value format with spaces only for separating options - ie.: (autostart=false startsecs=10). The optional user argument gives the userid that the process should be run as (if supervisord is run as root).

In most cases you will only need to give the 4 first parts:

priority process_name command [[args]]
eventlisteners

A list of eventlisteners you’d like supervisord to run as subprocesses to subscribe to event notifications. One per line. Relevant supervisor documentation about events at http://supervisord.org/manual/current/events.html.

processname events command [[args]]

events is a comma-separated list (without spaces) of event type names that the listener is “interested” in receiving notifications for.

Supervisor provides one event listener called memmon which can be used to restart supervisord child process once they reach a certain memory limit. Note that you need to define the variables user, password and serverurl (described in the supported options above) to be able to use the memmon listener. An example of defining a memmon event listener, which analyzes memory usage every 60 seconds and restarts as needed could look like:

MemoryMonitor TICK_60 ${buildout:bin-directory}/memmon [-p process_name=200MB]
groups

A list of programs that become part of a group. One per line. The format of a line is as follow:

priority group_name program_names

The programs_name is a comma-separated list of program names.

env-path
The environment variable PATH, e.g. /bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin

Example usage

We’ll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = supervisor
... index = http://pypi.python.org/simple
... [zeo]
... location = /a/b/c
... [instance1]
... location = /e/f
... [instance2]
... location = /g/h
...
... [supervisor]
... recipe = fourdigits.recipe.supervisor
... plugins =
...       superlance
... port = 9001
... user = mustapha
... password = secret
... serverurl = http://supervisor.mustap.com
... programs =
...       10 zeo ${zeo:location}/bin/runzeo ${zeo:location}
...       20 instance1 ${instance1:location}/bin/runzope ${instance1:location} true
...       30 instance2 (autostart=false) ${instance2:location}/bin/runzope true
...       40 maildrophost ${buildout:bin-directory}/maildropctl true
...       50 other ${buildout:bin-directory}/other [-n 100] /tmp
...       60 other2 ${buildout:bin-directory}/other2 [-n 100] true
...       70 other3 (startsecs=10) ${buildout:bin-directory}/other3 [-n -h -v --no-detach] /tmp3 true www-data
... eventlisteners =
...       Memmon TICK_60 ${buildout:bin-directory}/memmon [-p instance1=200MB]
...       HttpOk TICK_60 ${buildout:bin-directory}/httpok [-p site1 -t 20 http://localhost:8080/]
... groups =
...       10 services zeo,instance1
...       20 others other,other2,other3
... """)

Chris Mc Donough said:

Note however that the "instance" script Plone uses to start Zope when
passed "fg" appears to use os.system, so the process that supervisor is
controlling isnt actually Plone, it's the controller script. This means
that "stop" and "start" tend to not do what you want. It's far better to
use "runzope", which actually execs the Python process which becomes Zope
See also
http://supervisord.org/manual/current/subprocesses.html#nondaemonizing_of_subprocesses

Running the buildout gives us:

>>> print system(buildout)
Getting distribution for 'zc.recipe.egg'.
...
Installing supervisor.
...
Generated script '/sample-buildout/bin/supervisorctl'.
<BLANKLINE>

Check that we have the ‘crashmail’, ‘memmon’ and ‘httpok’ scripts from superlance:

>>> ls(sample_buildout, 'bin')
-  buildout
-  crashmail
-  httpok
-  memmon
-  supervisorctl
-  supervisord

You can now just run the supervisord like this:

$ bin/supervisord

and control it with supervisorctl:

$ bin/supervisorctl

Memory monitoring via supervisor’s memmon event listener will be executed via supervisord with the following:

$ bin/memmon

now, get a look to the generated supervisord.conf file:

>>> cat('parts', 'supervisor', 'supervisord.conf') #doctest: +REPORT_NDIFF
<BLANKLINE>
[supervisord]
childlogdir = /sample-buildout/var/log
logfile = /sample-buildout/var/log/supervisord.log
logfile_maxbytes = 50MB
logfile_backups = 10
loglevel = info
pidfile = /sample-buildout/var/supervisord.pid
umask = 022
nodaemon = false
nocleanup = false
<BLANKLINE>
[inet_http_server]
port = 9001
username = mustapha
password = secret
<BLANKLINE>
[supervisorctl]
serverurl = http://supervisor.mustap.com
username = mustapha
password = secret
<BLANKLINE>
[rpcinterface:supervisor]
supervisor.rpcinterface_factory=supervisor.rpcinterface:make_main_rpcinterface
<BLANKLINE>
[program:zeo]
command = /a/b/c/bin/runzeo
process_name = zeo
directory = /a/b/c
priority = 10
redirect_stderr = false
<BLANKLINE>
<BLANKLINE>
[program:instance1]
command = /e/f/bin/runzope
process_name = instance1
directory = /e/f
priority = 20
redirect_stderr = true
<BLANKLINE>
<BLANKLINE>
[program:instance2]
command = /g/h/bin/runzope
process_name = instance2
directory = /g/h/bin
priority = 30
redirect_stderr = true
autostart = false
<BLANKLINE>
[program:maildrophost]
command = /sample-buildout/bin/maildropctl
process_name = maildrophost
directory = /sample-buildout/bin
priority = 40
redirect_stderr = true
<BLANKLINE>
<BLANKLINE>
[program:other]
command = /sample-buildout/bin/other -n 100
process_name = other
directory = /tmp
priority = 50
redirect_stderr = false
<BLANKLINE>
<BLANKLINE>
[program:other2]
command = /sample-buildout/bin/other2 -n 100
process_name = other2
directory = /sample-buildout/bin
priority = 60
redirect_stderr = true
<BLANKLINE>
<BLANKLINE>
[program:other3]
command = /sample-buildout/bin/other3 -n -h -v --no-detach
process_name = other3
directory = /tmp3
priority = 70
redirect_stderr = true
user = www-data
startsecs = 10
<BLANKLINE>
[eventlistener:Memmon]
command = /sample-buildout/bin/memmon -p instance1=200MB
events = TICK_60
process_name=Memmon
environment=SUPERVISOR_USERNAME='mustapha',SUPERVISOR_PASSWORD='secret',SUPERVISOR_SERVER_URL='http://supervisor.mustap.com'
<BLANKLINE>
[eventlistener:HttpOk]
command = /sample-buildout/bin/httpok -p site1 -t 20 http://localhost:8080/
events = TICK_60
process_name=HttpOk
environment=SUPERVISOR_USERNAME='mustapha',SUPERVISOR_PASSWORD='secret',SUPERVISOR_SERVER_URL='http://supervisor.mustap.com'
<BLANKLINE>
[group:services]
programs = zeo,instance1
priority = 10
<BLANKLINE>
[group:others]
programs = other,other2,other3
priority = 20

and if we look to generated supervisord script we will see that the configuration file is given as argument with the ‘-c’ option:

>>> cat('bin', 'supervisord')
...
<BLANKLINE>
...
<BLANKLINE>
import sys; sys.argv.extend(["-c","/sample-buildout/parts/supervisor/supervisord.conf"])
<BLANKLINE>
import supervisor.supervisord
<BLANKLINE>
if __name__ == '__main__':
    supervisor.supervisord.main()

The control script contains all specified options, like server url and username. This allows to run it as is:

>>> cat('bin', 'supervisorctl')
...
<BLANKLINE>
...
<BLANKLINE>
import sys; sys.argv[1:1] = ["-c","/sample-buildout/parts/supervisor/supervisord.conf"]
<BLANKLINE>
import supervisor.supervisorctl
<BLANKLINE>
if __name__ == '__main__':
    supervisor.supervisorctl.main(sys.argv[1:])

Memmon delegates all work to the egg’s memmon Python script itself:

>>> cat('bin', 'memmon')
...
<BLANKLINE>
...
<BLANKLINE>
import superlance.memmon
<BLANKLINE>
if __name__ == '__main__':
    superlance.memmon.main()

The log directory is created by the recipe:

>>> ls(sample_buildout, 'var')
d  log

You can also specify a custom port to run the supervisor on, and the control script will automatically try to connect to the specified port:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = supervisor
... index = http://pypi.python.org/simple/
...
... [supervisor]
... recipe = fourdigits.recipe.supervisor
... port = 9005
... programs =
...       50 other ${buildout:bin-directory}/other [-n 100] /tmp
... """)

Here we specified that the supervisor will be launched on port 9005. We can see that this is also set in the control script:

>>> _ = system(buildout)
>>> cat('bin', 'supervisorctl')
...
<BLANKLINE>
...
<BLANKLINE>
import sys; sys.argv[1:1] = ["-c","/sample-buildout/parts/supervisor/supervisord.conf"]
<BLANKLINE>
import supervisor.supervisorctl
<BLANKLINE>
if __name__ == '__main__':
    supervisor.supervisorctl.main(sys.argv[1:])

It is possible to run http server through unix socket rather than tcp:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = supervisor
... index = http://pypi.python.org/simple/
...
... [supervisor]
... recipe = fourdigits.recipe.supervisor
... http-socket = unix
... user = foobar
... password = foobar
... file = /tmp/supervisor.sock
... programs =
...       50 other ${buildout:bin-directory}/other [-n 100] /tmp
... """)
>>> _ = system(buildout)
>>> cat('parts', 'supervisor', 'supervisord.conf') #doctest: +REPORT_NDIFF
<BLANKLINE>
...
<BLANKLINE>
[unix_http_server]
file = /tmp/supervisor.sock
username = foobar
password = foobar
chmod = 0700
<BLANKLINE>
[supervisorctl]
serverurl = unix:///tmp/supervisor.sock
username = foobar
password = foobar
<BLANKLINE>
...
<BLANKLINE>

Contributors

  • Mustapha Benali, Author
  • Hanno Schlichting, Contributor
  • gawel, Contributor
  • aburkhalter, Contributor
  • Amos Latteier, Contributor
  • Jacob Radford, Contributor
  • Jonathan Ballet, Contributor
  • Domen Kozar, Contributor
  • Lucie Lejard, Contributor
  • Servilio Afre Puentes, Contributor
  • Juan A. Diaz (nueces), Contributor
Release History

Release History

0.18dev

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
fourdigits.recipe.supervisor-0.18dev.tar.gz (13.7 kB) Copy SHA256 Checksum SHA256 Source Jan 17, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting