supervisord 的安装
使用 easy_install 安装 supervisord
sudo easy_install supervisord
supervisord 的配置
生成配置文件
sudo sh -c \'/usr/local/bin/echo_supervisord_conf > /etc/supervisord.conf\'
supervisord 的配置文件如下
; Sample supervisor config file.
;
; For more information on the config file, please see:
; http://supervisord.org/configuration.html
;
; Note: shell expansion (\"~\" or \"$HOME\") is not supported. Environment
; variables can be expanded using this syntax: \"%(ENV_HOME)s\".
[unix_http_server]
file=/tmp/supervisor.sock ; (the path to the socket file)
;chmod=0700 ; socket file mode (default 0700)
;chown=nobody:nogroup ; socket file uid:gid owner
;username=user ; (default is no username (open server))
;password=123 ; (default is no password (open server))
[inet_http_server] ; inet (TCP) server disabled by default
port=127.0.0.1:9001 ; (ip_address:port specifier, *:port for all iface)
username=ops ; (default is no username (open server))
password=vipshop ; (default is no password (open server))
[supervisord]
logfile=/tmp/supervisord.log ; (main log file;default $CWD/supervisord.log)
logfile_maxbytes=50MB ; (max main logfile bytes b4 rotation;default 50MB)
logfile_backups=10 ; (num of main logfile rotation backups;default 10)
loglevel=info ; (log level;default info; others: debug,warn,trace)
pidfile=/tmp/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
nodaemon=false ; (start in foreground if true;default false)
minfds=1024 ; (min. avail startup file descriptors;default 1024)
minprocs=200 ; (min. avail process descriptors;default 200)
;umask=022 ; (process file creation umask;default 022)
;user=chrism ; (default is current user, required if root)
;identifier=supervisor ; (supervisord identifier, default is \'supervisor\')
;directory=/tmp ; (default is not to cd during start)
;nocleanup=true ; (don\'t clean up tempfiles at start;default false)
;childlogdir=/tmp ; (\'AUTO\' child log dir, default $TEMP)
;environment=KEY=\"value\" ; (key value pairs to add to environment)
;strip_ansi=false ; (strip ansi escape codes in logs; def. false)
; the below section must remain in the config file for RPC
; (supervisorctl/web interface) to work, additional interfaces may be
; added by defining them in separate rpcinterface: sections
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris ; should be same as http_username if set
;password=123 ; should be same as http_password if set
;prompt=mysupervisor ; cmd line prompt (default \"supervisor\")
;history_file=~/.sc_history ; use readline history if available
; The below sample program section shows all possible program subsection values,
; create one or more \'real\' program: sections to be able to control them under
; supervisor.
[program:ds.tools.vip.com]
command=sh /apps/dat/web/newcode/debug_ds/run.sh ; the program (relative uses PATH, can take args)
process_name=%(program_name)s ; process_name expr (default %(program_name)s)
numprocs=1 ; number of processes copies to start (def 1)
directory=/apps/dat/web/newcode/debug_ds/ ; directory to cwd to before exec (def no cwd)
;umask=022 ; umask for process (default None)
;priority=999 ; the relative start priority (default 999)
autostart=true ; start at supervisord start (default: true)
autorestart=true ; whether/when to restart (default: unexpected)
;startsecs=1 ; number of secs prog must stay running (def. 1)
;startretries=3 ; max # of serial start failures (default 3)
;exitcodes=0,2 ; \'expected\' exit codes for process (default 0,2)
stopsignal=QUIT ; signal used to kill process (default TERM)
stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; send stop signal to the UNIX process group (default false)
;killasgroup=false ; SIGKILL the UNIX process group (def false)
;user=chrism ; setuid to this UNIX account to run the program
;redirect_stderr=true ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10 ; # of stdout logfile backups (default 10)
;stdout_capture_maxbytes=1MB ; number of bytes in \'capturemode\' (default 0)
;stdout_events_enabled=false ; emit events on stdout writes (default false)
;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10 ; # of stderr logfile backups (default 10)
;stderr_capture_maxbytes=1MB ; number of bytes in \'capturemode\' (default 0)
;stderr_events_enabled=false ; emit events on stderr writes (default false)
;environment=A=\"1\",B=\"2\" ; process environment additions (def no adds)
;serverurl=AUTO ; override serverurl computation (childutils)
; The below sample eventlistener section shows all possible
; eventlistener subsection values, create one or more \'real\'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.
;[eventlistener:theeventlistenername]
;command=/bin/eventlistener ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1 ; number of processes copies to start (def 1)
;events=EVENT ; event notif. types to subscribe to (req\'d)
;buffer_size=10 ; event buffer queue size (default 10)
;directory=/tmp ; directory to cwd to before exec (def no cwd)
;umask=022 ; umask for process (default None)
;priority=-1 ; the relative start priority (default -1)
;autostart=true ; start at supervisord start (default: true)
;autorestart=unexpected ; whether/when to restart (default: unexpected)
;startsecs=1 ; number of secs prog must stay running (def. 1)
;startretries=3 ; max # of serial start failures (default 3)
;exitcodes=0,2 ; \'expected\' exit codes for process (default 0,2)
;stopsignal=QUIT ; signal used to kill process (default TERM)
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; send stop signal to the UNIX process group (default false)
;killasgroup=false ; SIGKILL the UNIX process group (def false)
;user=chrism ; setuid to this UNIX account to run the program
;redirect_stderr=true ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10 ; # of stdout logfile backups (default 10)
;stdout_events_enabled=false ; emit events on stdout writes (default false)
;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups ; # of stderr logfile backups (default 10)
;stderr_events_enabled=false ; emit events on stderr writes (default false)
;environment=A=\"1\",B=\"2\" ; process environment additions
;serverurl=AUTO ; override serverurl computation (childutils)
; The below sample group section shows all possible group values,
; create one or more \'real\' group: sections to create \"heterogeneous\"
; process groups.
;[group:thegroupname]
;programs=progname1,progname2 ; each refers to \'x\' in [program:x] definitions
;priority=999 ; the relative start priority (default 999)
; The [include] section can just contain the \"files\" setting. This
; setting can list multiple files (separated by whitespace or
; newlines). It can also contain wildcards. The filenames are
; interpreted as relative to this file. Included files *cannot*
; include files themselves.
;[include]
;files = relative/directory/*.ini
启动 supervisord
启动 supervisord 的命令如下：
supervisord
使用 supervisorctl 查看 supervisord 相关信息
$ supervisorctl
ds.tools.vip.com RUNNING pid 13794, uptime 0:17:25
supervisor>
查看 supervisor 的所有命令可以使用 help 帮助命令
~]$ supervisorctl
ds.tools.vip.com RUNNING pid 13794, uptime 0:17:25
supervisor> help
default commands (type help ):
=====================================
add clear fg open quit remove restart start stop update
avail exit maintail pid reload reread shutdown status tail version
查看某个命令的具体用法为 help commandname
supervisor> help start
start Start a process
start :* Start all processes in a group
start Start multiple processes or groups
start all Start all processes
supervisor>
XML-RPC API 的使用
通过配置文件所知，我们的配置的 url 如下：
[inet_http_server] ; inet (TCP) server disabled by default
port=127.0.0.1:9001 ; (ip_address:port specifier, *:port for all iface)
username=ops ; (default is no username (open server))
password=vipshop ; (default is no password (open server))
连接 supervisord 的代码示例如下：
import xmlrpclib
server = xmlrpclib.Server(\'http://ops:vipshop@127.0.0.1:9001/RPC2\')
当我们不知道 supervisord 有哪些方法的时候，可以使用如下接口查询出 API 支持的方法
methods = server.system.listMethods()
print methods
输出如下：
>>> print methods
[\'supervisor.addProcessGroup\', \'supervisor.clearAllProcessLogs\', \'supervisor.clearLog\', \'supervisor.clearProcessLog\', \'supervisor.clearProcessLogs\', \'supervisor.getAPIVersion\', \'supervisor.getAllConfigInfo\', \'supervisor.getAllProcessInfo\', \'supervisor.getIdentification\', \'supervisor.getPID\', \'supervisor.getProcessInfo\', \'supervisor.getState\', \'supervisor.getSupervisorVersion\', \'supervisor.getVersion\', \'supervisor.readLog\', \'supervisor.readMainLog\', \'supervisor.readProcessLog\', \'supervisor.readProcessStderrLog\', \'supervisor.readProcessStdoutLog\', \'supervisor.reloadConfig\', \'supervisor.removeProcessGroup\', \'supervisor.restart\', \'supervisor.sendProcessStdin\', \'supervisor.sendRemoteCommEvent\', \'supervisor.shutdown\', \'supervisor.startAllProcesses\', \'supervisor.startProcess\', \'supervisor.startProcessGroup\', \'supervisor.stopAllProcesses\', \'supervisor.stopProcess\', \'supervisor.stopProcessGroup\', \'supervisor.tailProcessLog\', \'supervisor.tailProcessStderrLog\', \'supervisor.tailProcessStdoutLog\', \'system.listMethods\', \'system.methodHelp\', \'system.methodSignature\', \'system.multicall\']
注：官方的文档的 XML-RPC API
查看某个进程的详细信息
proInfo = server.supervisor.getProcessInfo(\'ds.tools.vip.com\')
print proInfo
输出如下：
{\'now\': 1405479228, \'group\': \'ds.tools.vip.com\', \'description\': \'pid 13794, uptime 0:25:45\', \'pid\': 13794, \'stderr_logfile\': \'/tmp/ds.tools.vip.com-stderr---supervisor-hWn1G5.log\', \'stop\': 0, \'statename\': \'RUNNING\', \'start\': 1405477683, \'state\': 20, \'stdout_logfile\': \'/tmp/ds.tools.vip.com-stdout---supervisor-JGiMlV.log\', \'logfile\': \'/tmp/ds.tools.vip.com-stdout---supervisor-JGiMlV.log\', \'exitstatus\': 0, \'spawnerr\': \'\', \'name\': \'ds.tools.vip.com\'}
具体详细的可以参考官方文档，列举的很详细，这只是一个简单的介绍。