我们在项目中经常会有服务需要常驻的需求,最近服务总是莫名其妙自己挂了,为了让服务可以异常挂掉后自动重启,可以使用supervisor(类似工具还有systemd)。
1:介绍
supervisord是python开发的一套通用的进程管理工具,能将一个普通的命令行进程变为后台daemon,并监控状态,还提供了web页面管理,能对进程进行自动重启等操作。
优点:1:可以页面管理进程; 2:单配置文件可控制多个程序;3:可以控制进程数量;4:进程资源控制能力比较强
缺点:1:不能管理后台运行程序; 2:对多进程服务,不能使用kill关闭; 3:supervisord本身需要被监控;4:开机自启依赖其他程序;5:不能跨主机
2:安装
平台要求:Supervisor已经过测试,可以在Linux(Ubuntu 9.10),Mac OS X(10.4 / 10.5 / 10.6)和Solaris(10 for Intel)和FreeBSD 6.1上运行。它可能在大多数UNIX系统上都能正常工作。在任何版本的Windows下,Supervisor 都不会运行。Supervisor 可以使用Python 2.4或更高版本,但不能在任何版本的Python 3下使用。
我使用的安装方法是pip安装:
1:安装:
pip install supervisord
2:查看是否安装成功:执行 supervisord -v 看到输出版本号代表成功了,我的输出了4.2.0
3:生成配置文件:
mkdir /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf
4:启动:supervisord -c /etc/supervisor/supervisord.conf
5:查看是否启动成功:ps -ef | grep supervisord 找到就代表启动成功了
6:配置子配置文件
修改supervisord.conf的[include]配置,把注释符”;“符号去掉,将files项改为"/etc/supervisor/conf.d/*.conf"
Tips:[include]这一行的注释也记得去掉,我忘记去掉了,导致排查了好一会
3:卸载
简单粗暴:运行pip uninstall命令就可以了
4:使用示例
在这里我使用nginx来做演示。
1:首先找到nginx路径和配置文件,输入:which nginx,会输出nginx路径 我的是/etc/bin/nginx/sbin/nginx,我们先把nginx kill掉。
2:设置nginx不以后台模式运行,修改nginx.conf 在头部worker_processes下一行输入“daemon off;”,然后重启nginx (如果配的是php,在php-fpm.conf找到daemonize,设置为daemonize=no)
3:在/etc/supervisor/conf.d/文件夹增加子进程配置文件 nginx.conf,文件内容如下:
[program:nginx]command=/etc/bin/nginx/sbin/nginx -c /etc/bin/nginx/conf/nginx.conf ; nginx路径
directory=/tmp ; 切换到目录
user=root ; 执行程序的用户
autorestart=true ; 自动重启
priority=999 ; 优先级
startsecs=1 ; 重启前等待时间
startretries=100 ; 最大重启次数
stdout_logfile=/tmp/supervisor/nginx/nginx.log ; 日志文件
stdout_logfile_maxbytes=10MB ; 日志文件最大容量
stderr_logfile=/tmp/supervisor/nginx/nginx_err.log ; 错误日志文件
stderr_logfile_maxbytes=1MB ; 错误日志文件最大容量
4:把刚刚设置里面的stdout_logfile和stderr_logfile相关日志目录创建好,并设置权限
mkdir -p /tmp/supervisor/nginx
chown -R www:www /tmp/supervisor/nginx
5:重新读取supervisord配置:执行: supervisorctl reread 会输出:nginx: available
6:更新子进程组:执行:supervisorctl update 会输出 : nginx:added process group
7:这时nginx应该已经被supervisord带起来了,我们ps -ef | grep nginx 查看一下,如果找到了,那么恭喜,代表配置成功了。 然后我们kill掉nginx主进程,再次ps -ef | grep nginx,可以看到一个新的nginx又会被supervisord创建出来。
5:查看子进程运行情况
可以输入“supervisorctl”命令,我的输出如下:
nginx RUNNING pid 25182, uptime 1:46:57
php RUNNING pid 2203, uptime 0:03:56
idgen RUNNING pid 24074, uptime 2:01:09
6:配置web界面:
在supervisord.cond注释掉inet_http_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=user ; default is no username (open server)
password=123 ; default is no password (open server)
然后重启主进程,输入:supervisorctl reload
这时候我们打开浏览器,访问http:你的服务器ip地址:9001,根据弹窗提示输入配置文件内的账号和密码,这是我们就可以看到页面如下,我们可以方便的在页面查看进程状态,对他们进行重启,停止等操作。
7:设置开机自启:
echo "supervisord -c /etc/supervisord.conf" >> /etc/rc.local
8:子进程配置文件详解:
;*为必须填写项
;*[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)02dprocess_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-xumask=022
;优先级,值越高,最后启动,最先被关闭,默认值999priority=999
;如果是true,当supervisor启动时,程序将会自动启动autostart=true
;*自动重启autorestart=true
;启动延时执行,默认1秒startsecs=10;启动尝试次数,默认3次startretries=3
;当退出码是0,2时,执行重启,默认值0,2exitcodes=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),说明1stopsignal=TERMstopwaitsecs=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
参考文章:
http://www.supervisord.org/running.html#adding-a-program