一、supervisor简介
Supervisor是用Python开发的一套通用的进程管理程序，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程。
注：本文以centos7为例，supervisor版本3.4.0。
二、supervisor安装
-
配置好yum源后，可以直接安装
yum install supervisor -
Debian/Ubuntu可通过apt安装
apt-get install supervisor -
pip安装
pip install supervisor -
easy_install安装
easy_install supervisor
三、supervisor使用
supervisor配置文件：/etc/supervisord.conf
通过easy_install或pip安装后，需要运行如下命令生成配置文件
$ mkdir /etc/supervisor
$ echo_supervisord_conf > /etc/supervisor/supervisord.conf
supervisor配置文件：/etc/supervisord/conf.d目录下，可通过配置文件修改
四、配置文件说明
supervisor.conf配置文件说明：
[unix_http_server]
file=/tmp/supervisor.sock ;UNIX socket 文件，supervisorctl 会使用
;chmod=0700 ;socket文件的mode，默认是0700
;chown=nobody:nogroup ;socket文件的owner，格式：uid:gid
;[inet_http_server] ;HTTP服务器，提供web管理界面
;port=127.0.0.1:9001 ;Web管理后台运行的IP和端口，如果开放到公网，需要注意安全性
;username=user ;登录管理后台的用户名
;password=123 ;登录管理后台的密码
[supervisord]
logfile=/tmp/supervisord.log ;日志文件，默认是 $CWD/supervisord.log
logfile_maxbytes=50MB ;日志文件大小，超出会rotate，默认 50MB，如果设成0，表示不限制大小
logfile_backups=10 ;日志文件保留备份数量默认10，设为0表示不备份
loglevel=info ;日志级别，默认info，其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false ;是否在前台启动，默认是false，即以 daemon 的方式启动
minfds=1024 ;可以打开的文件描述符的最小值，默认 1024
minprocs=200 ;可以打开的进程数的最小值，默认 200
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
; [program:xx]是被管理的进程配置参数，xx是进程的名称
[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run ; 程序启动命令
autostart=true ; 在supervisord启动的时候也自动启动
startsecs=10 ; 启动10秒后没有异常退出，就表示进程正常启动了，默认为1秒
autorestart=true ; 程序退出后自动重启,可选值：[unexpected,true,false]，默认为unexpected，表示进程意外杀死后才重启
startretries=3 ; 启动失败自动重试次数，默认是3
user=tomcat ; 用哪个用户启动进程，默认是root
priority=999 ; 进程启动优先级，默认999，值小的优先启动
redirect_stderr=true ; 把stderr重定向到stdout，默认false
stdout_logfile_maxbytes=20MB ; stdout 日志文件大小，默认50MB
stdout_logfile_backups = 20 ; stdout 日志文件备份数，默认是10
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
killasgroup=false ;默认为false，向进程组发送kill信号，包括子进程
;包含其它配置文件
[include]
files = /etc/supervisor/conf.d/*.conf ;可以指定一个或多个以.conf结束的配置文件
上述配置文件只是部分配置，配置文件可以通过运行echo_supervisord_conf获得。这个配置文件一般情况下不需要更改，除了最后的[include]部分，其余保持默认即可。
比较完整的配置文件展示：
[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] ; 配置web后台
;port=127.0.0.1:9001 ; 指定ip_address:port, 使用 *:port 监听所有 IP
;username=user ; 默认没有用户名 (open server)
;password=123 ; 默认没有密码 (open server)
[supervisord]
logfile=/tmp/supervisord.log ; 日志文件; 默认 $CWD/supervisord.log
logfile_maxbytes=50MB ; 日志文件最大大小; 默认 50MB
logfile_backups=10 ; # of main logfile backups; 0 means none, default 10
loglevel=info ; log level; default info; others: debug,warn,trace
pidfile=/tmp/supervisord.pid ; pid文件
nodaemon=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 rpcinterface:supervisor 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:x] sections.
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
; 配置 supervisorctl
; configure it match the settings in either the unix_http_server
; or inet_http_server section.
[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 in [*_http_server] if set
;password=123 ; should be same as in [*_http_server] if set
;prompt=mysupervisor ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history ; use readline history if available
; 下面是子进程配置文件示例
; Create one or more 'real' program: sections to be able to control them under
; supervisor.
;[program:theprogramname]
;command=/bin/cat ; 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=/tmp ; 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)
;startsecs=1 ; # of secs prog must stay up to be running (def. 1)
;startretries=3 ; max # of serial start failures when starting (default 3)
;autorestart=unexpected ; when to restart if exited after running (def: unexpected)
;exitcodes=0,2 ; 'expected' exit codes used with autorestart (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 (0 means none, 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 (0 means none, 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 sample eventlistener section below shows all possible eventlistener
; subsection values. Create one or more 'real' eventlistener: sections to be
; able to handle event notifications sent by supervisord.
;[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)
;startsecs=1 ; # of secs prog must stay up to be running (def. 1)
;startretries=3 ; max # of serial start failures when starting (default 3)
;autorestart=unexpected ; autorestart if exited after running (def: unexpected)
;exitcodes=0,2 ; 'expected' exit codes used with autorestart (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=false ; redirect_stderr=true is not allowed for eventlisteners
;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 (0 means none, 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=10 ; # of stderr logfile backups (0 means none, 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 sample group section below 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)
; 配置include files
; 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]
; .ini和.conf都支持
files = relative/directory/*.ini
子进程配置文件说明：
#*为必须填写项
#项目名
[program:blog]
#脚本目录
directory=/opt/bin
#*命令路径,如果使用python启动的程序应该为 python /home/test.py,
#不建议放入/home/user/, 对于非user用户一般情况下是不能访问
#脚本执行命令
command=/usr/bin/python /opt/bin/test.py
#当numprocs为1时,process_name=%(program_name)s;
#当numprocs>=2时,%(program_name)s_%(process_num)02d
process_name=%(program_name)s
#进程数量
numprocs=1
#执行目录,若有/home/supervisor_test/test1.py
#将directory设置成/home/supervisor_test
#则command只需设置成python test1.py
#否则command必须设置成绝对执行目录
directory=/tmp
#掩码:--- -w- -w-, 转换后rwx r-x w-x
umask=022
#优先级,值越高,最后启动,最先被关闭,默认值999
priority=999
#*supervisor启动的时候程序是否随着同时启动，默认True
autostart=true
#*自动重启，当程序exit的时候，这个program不会自动重启,默认unexpected，设置子进程挂掉后自动重启的情况，有三个选项，false,unexpected和true。如果为false的时候，无论什么情况下，都不会被重新启动，如果为unexpected，只有当进程的退出码不在下面的exitcodes里面定义的
autorestart=false
#启动延时执行，这个选项是子进程多少秒之后启动，此时状态如果是running，则我们认为启动成功了。默认值为1
startsecs=1
#启动尝试次数,默认3次
startretries=3
#当退出码是0,2时,执行重启,默认值0,2
exitcodes=0,2
#停止信号,默认TERM
#中断:INT(类似于Ctrl+C)(kill -INT pid),退出后会将写文件或日志(推荐)
#终止:TERM(kill -TERM pid)
#挂起:HUP(kill -HUP pid),注意与Ctrl+Z/kill -stop pid不同
#从容停止:QUIT(kill -QUIT pid)
#KILL, USR1, USR2其他见命令(kill -l),说明1
stopsignal=TERM
stopwaitsecs=10
#脚本运行的用户身份
user = test
#日志输出
stderr_logfile=/tmp/blog_stderr.log
stdout_logfile=/tmp/blog_stdout.log
#把stderr重定向到stdout，默认 false
redirect_stderr = true
#stdout日志文件大小，默认 50MB
stdout_logfile_maxbytes = 20MB
#stdout日志文件备份数
stdout_logfile_backups = 20
#环境变量设置
environment=A="1",B="2"
serverurl=AUTO
子进程配置示例
[program:htmlQueue]
command=/usr/bin/php think queue:listen --queue htmlQueue --timeout=1800 ;
directory=/home/cyzone/public_html/hmh.cyzone.cn ;
autostart=true ;
autorestart=true ;自动启动
startsecs=1 ;程序重启时候停留在runing状态的秒数
startretries=10 ;启动失败时的最多重试次数
user=apache ;
redirect_stderr=true ;重定向stderr到stdout
stdout_logfile=/home/cyzone/public_html/hmh.cyzone.cn/runtime/htmlQueue.log ;
五、supervisor启动
-
使用
pip或者easy_install安装的supervisor运行如下命令即可启动$ supervisordsupervisor 默认在以下路径查找配置文件：/usr/etc/supervisord.conf, /usr/supervisord.conf, supervisord.conf, etc/supervisord.conf, /etc/supervisord.conf, /etc/supervisor/supervisord.conf
如需指定主配置文件，则需要使用
-c$参数$ supervisord -c /etc/supervisor/supervisord.conf查看安装的版本
$ supervisord -v查看supervisor的状态
$ supervisorctl status注：
supervisord是主进程，supervisorctl是给守护进程发送命令的客户端工具 -
使用
apt-get安装的supervisor直接可以通过如下命令运行$ /etc/init.d/supervisor start
六、supervisor命令说明
supervisord
supervisord 是主进程。
通过supervisord -h可以查看帮助说明。示例：
-c/--configuration FILENAME ;指定配置文件
-n/--nodaemon ;运行在前台（调试用）
-v/--version ;打印版本信息
-u/--user USER ;以指定用户（或用户ID）运行
-m/--umask UMASK ;指定子进程的umask，默认是022
-l/--logfile FILENAME ;指定日志文件
-e/--loglevel LEVEL ;指定日志级别
supervisorctl
supervisorctl 是客户端程序，用于向supervisord发起命令。
通过supervisorctl -h可以查看帮助说明。我们主要关心的是其action命令：
$ supervisorctl help
default commands (type help ):
=====================================
add exit open reload restart start tail
avail fg pid remove shutdown status update
clear maintail quit reread signal stop version
这些命令对于控制子进程非常重要。示例:
supervisorctl status //查看所有进程的状态
supervisorctl status //查看指定进程状态
supervisorctl stop //停止停止指定子进程
supervisorctl stop all //停止所有子进程
supervisorctl start //启动指定子进程
supervisorctl start all //启动所有子进程
supervisorctl restart //重启指定子进程
supervisorctl restart all //重启指定子进程
supervisorctl update //重新加载配置，如配置文件里将新的子进程加入进程组，设置autostart=true则会启动新新增的子进程
supervisorctl reload //重新启动配置中的所有程序
supervisorctl reread //重新加载配置文件
supervisorctl add //添加子进程到进程组
supervisorctl reomve //从进程组移除子进程，需要先stop。注意：移除后，需要使用reread和update才能重新运行该进程
注：直接输入supervisorctl进入supervisorctl的shell交互界面，此时上面的命令不带supervisorctl可直接使用。
七、web界面操作
需要开启supervisord.conf注释掉的这4行：
[inet_http_server] ; inet (TCP) server disabled by default
port=127.0.0.1:9001 ; ip_address:port specifier, *:port for all iface
username=user ; default is no username (open server)
password=123 ; default is no password (open server)
端口默认是监听127.0.0.1:9001，这里方便测试，修改为如下代码：
port=*:9001
然后重启主进程supervisord：
$ supervisorctl reload
浏览器访问：http://myip:9001 ，输入用户名、密码后，即可看到web页面：
supervisord.png
注意：如果修改配置文件时，[inet_http_server]这一行被注释，会导致不仅web需要认证，命令行使用supervisorctl也需要认证，这时候就需要在交互式命令行里输入用户名、密码才能进行下一步的操作。