不灭的焱

在项目中，经常有脚本需要常驻运行的需求。以PHP脚本为例，最简单的方式是：

$ nohup php cli.php &

这样能保证当前终端被关闭或者按CRTL+C后，脚本仍在后台运行。但是没法保证脚本异常后自动重启等。

官网介绍：http://supervisord.org/

Supervisor是用Python开发的一套通用的进程管理程序，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程

本文所用环境：

• CentOS 7
• Python 2.7.5
• Supervisor 3.3.4

一、Supervisor安装

配置好yum源后，可以直接安装【本文安装方法】

yum install supervisor

查看安装的版本：

$ supervisord -v
# 输出版本号：3.4.0

二、Supervisor启动

supervisord -c /etc/supervisord.conf

三、Supervisor使用

supervisor配置文件：/etc/supervisord.conf

注：supervisor的配置文件默认是不全的，不过在大部分默认的情况下，上面说的基本功能已经满足。

子进程配置文件路径：/etc/supervisord.d/

注：默认子进程配置文件为ini格式，可在supervisor主配置文件中修改。

四、Supervisor使用

给需要管理的子进程(程序)编写一个配置文件，放在/etc/supervisor.d/目录下，以.ini作为扩展名（每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起）。如任意定义一个和脚本相关的项目名称的选项组（/etc/supervisord.d/test.ini）：

[program:queue]
command=php /www/group/yii queue/listen
numprocs=2
process_name=%(program_name)s_%(process_num)02d
autostart=true
autorestart=true
user=root
logfile=/tmp/queue.log

[program:import-queue]
command=php /www/group/yii import-queue/listen
numprocs=2
process_name=%(program_name)s_%(process_num)02d
autostart=true
autorestart=true
user=root
logfile=/tmp/import-queue.log

子进程配置文件说明：

;*为必须填写项
;*[program:应用名称]
[program:cat]

;*命令路径,如果使用python启动的程序应该为 python /home/test.py, 
;不建议放入/home/user/, 对于非user用户一般情况下是不能访问
command=/bin/cat

;当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

;如果是true,当supervisor启动时,程序将会自动启动
autostart=true

;*自动重启
autorestart=true

;启动延时执行,默认1秒
startsecs=10

;启动尝试次数,默认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

;*以root用户执行
user=root

;重定向
redirect_stderr=false

stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_capture_maxbytes=1MB

;环境变量设置
environment=A="1",B="2"

serverurl=AUTO

五、Supervisor命令说明

supervisorctl status        //查看所有进程的状态
supervisorctl stop es       //停止es
supervisorctl start es      //启动es
supervisorctl restart es    //重启es
supervisorctl update es     //配置文件修改后使用该命令加载新的配置
supervisorctl reload        //重新启动配置中的所有程序

注：把es换成all可以管理配置中的所有进程。直接输入supervisorctl进入supervisorctl的shell交互界面，此时上面的命令不带supervisorctl可直接使用。

• help # 查看帮助
• exit #退出
• status # 查看程序状态
• stop program_name # 关闭 指定的程序
• start program_name # 启动 指定的程序
• restart program_name # 重启 指定的程序
• tail -f program_name # 查看 该程序的日志
• update program_name # 重启配置文件修改过的程序（修改了配置，通过这个命令加载新的配置)

使用supervisor进程管理命令之前先启动supervisord，否则程序报错。
使用命令supervisord -c /etc/supervisord.conf启动。

systemctl start supervisord.service     //启动supervisor并加载默认配置文件
systemctl enable supervisord.service    //将supervisor加入开机启动项

六、常见问题

1. unix:///var/run/supervisor.sock no such file
   问题描述：安装好supervisor没有开启服务直接使用supervisorctl报的错
   解决办法：supervisord -c /etc/supervisord.conf

2. command中指定的进程已经起来，但supervisor还不断重启
   问题描述：command中启动方式为后台启动，导致识别不到pid，然后不断重启，这里使用的是elasticsearch，command指定的是$path/bin/elasticsearch -d
   解决办法：supervisor无法检测后台启动进程的pid，而supervisor本身就是后台启动守护进程，因此不用担心这个

3. 启动了多个supervisord服务，导致无法正常关闭服务
   问题描述：在运行supervisord -c /etc/supervisord.conf之前，直接运行过supervisord -c /etc/supervisord.d/xx.conf导致有些进程被多个superviord管理，无法正常关闭进程。
   解决办法：使用ps -fe | grep supervisord查看所有启动过的supervisord服务，kill相关的进程。

工作中的一次实例

监控部署开源Wiki系统BookStack

1、进入supervisor的配置目录

cd /etc/supervisord.d/

2、配置守护进程 创建bookstack.ini文件，并配置。

[program:BookStack]
directory=/www/wwwroot/test.bookstack.com
command=/www/wwwroot/test.bookstack.com/BookStack
autostart=true
autorestart=true
startretries=3
user=www
redirect_stderr=true
stdout_logfile=/var/log/supervisor/BookStack.log

配置完成之后，重启Supervisor

# 提交新建日志文件
touch /var/log/supervisor/BookStack.log
chown -R www:www /var/log/supervisor
 
# 启动Supervisor（注意：已启动了就不要再启动了）
supervisord -c /etc/supervisord.conf
 
# 重启Supervisor
supervisorctl reload